![]() For a human-readable URL, add a notion property named Slug to your database pages and enter a value in there that will work well in a URL. Slugsīy default, pages will be given a slug based on the Notion id. So if you create pages directly in the Outline, you won't be able to fill in any of these properties, other than the page title. For example, we use a simple kanban board view to see where each page is in our workflow:ĭocu-notion supports this by letting you link to database pages from your outline.įor some reason Notion only allows properties on pages that are part of a database. The advantage of this is that they can then have metadata properties that fit your workflow. One of the big attractions of Notion for large documentation projects is that you can treat your pages as database items. Github Actions) won't have the old version around, so it will disappear from your site. But if you don't commit files, your CI system (e.g. You probably want to keep publishing the old version until the new one is ready. Imagine the case where a document that previously had a Status property of Publish now has a different status. Note that if you choose not to commit, the workflow feature (see below) won't work for you. Most projects should probably commit the current markdown and image files each time you run docu-notion. "pull": "cross-var docu-notion -n %DOCU_NOTION_INTEGRATION_TOKEN% -r %DOCU_NOTION_ROOT_PAGE%"Īnd then run that with npm run pull. The following works well for Docusaurus instances: ![]() Means that the id is "0456aa5842946PRETEND4f37c97a0e5".ĭetermine where you want the markdown files and images to land. Pull your pagesįirst, determine the id of your root page by clicking "Share" and looking at the the url it gives you. If those matter to you, instead make new pages under the "Database" and then link to them in your outline pages. You can add content pages directly here, but then you won't be able to make use of the workflow features. Add your pages under your Outline page.Ĭurrently, docu-notion expects that each page has only one of the following: sub-pages, links to other pages, or normal content. In Notion, click "Share" on the root of your documentation and "invite" your integration to it.ĥ. "Invite" your Notion Integration to read you page Follow these instructions to make an integration and get your token. In order for docu-notion to read your site via Notion's API, you need to create what Notion calls an "integration". In Notion, duplicate the docu-notion template For a shortcut with github actions, search, and deployment to github pages, you can just copy this template. Set up your documentation site.įirst, prepare your markdown-based static file system like Docusaurus. It also allows you to leverage Notion's database tools to control workflow, Notion's commenting feature to discuss changes, etc.Įxample Site: Instructions 1. Using Notion instead of raw markdown files means that you don't have to teach non-developers how to make git commits and pull requests. Docu-notion lets you use Notion as your editor for Docusaurus. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |