Product Thumbnail

Notation

Documentation tooling for engineers

Writing
Developer Tools
GitHub
Notion

Hunted byKristian GaylordKristian Gaylord

Notation allows you to write markdown and automatically publish it Notion. Once it's in Notion, it can be internal, password protected, personal, or you can ship it as a public website. You also get all of Notion's AI, search, and formatting for free.

Top comment

Design Philosophy 1 — Documentation should not be managed separately from the repo. Documentation describes code. It should live with the code, have dinner with the code, go to bed with the code, and get up in the morning with the code. 2 — I should not have to login to some separate service to update docs after I merge and deploy code. That's hard to keep track of. Engineers cannot be trusted to workout outside the repo. Online documentation tools give me JIRA vibes. No thank youuu. 3 — The only frontend framework I want to think about is Markdown. Docusaurus is an interesting product but it's too complicated. I do not want to wrestle with React. I do not want to deploy a website. 4 — Some people are not engineers. They should be able to read my docs. Users, product mommies, etc. 5 — Docs should be highly searchable. Good search is a hard problem so better let someone else worry about that. 6 — Documentation should be subject to the same review & CI process as code. See point 2.

Comment highlights

Found a way to make writing and sharing content almost too easy. No more switching tabs—just type, publish, and relax. Love the convenience!
For anyone who uses Notion extensively this tool is a fantastic addition . The ability to handle markdown and utilize Notion’s AI and search capabilities for free is impressive. Great job on bringing this to life!
Managing markdown and publishing it directly to Notion sounds incredibly useful. The flexibility to choose between internal, password-protected, or public access adds great value.
The option to deploy your documentation as a public website or keep it internal within Notion is a flexible feature that caters to diffrent team needs
The feature where documentation updates automatically upon merging code is a brilliant addition. It ensures that docs are always up-to-date without any extra steps
Hi there, the ability to use Notions powerful search and formatting features with Markdown documentation is a fantastic combination. It really brings out the best of both worlds
hmm, this seems to be interesting but do you get AI help while documenting as well? Congratulations on the launch!
I’m excited about the prospect of using markdown for writing and having it seamlessly integrate with Notion’s capabilities.
This looks like a really useful tool for keeping documentation organized and accessible. I appreciate the focus on simplicity and integration.
the idea of writing in markdown and instantly publishing to nothion sounds incredibly useful . I’m wondering how customizable the privacy settings are can you easily switch between personal and public access? Wishing you success with this integration!
I love how Notation makes it easy to deploy documentation as a Notion page or a full website. It’s great to have flexible option!
Notation nails the integration of documentation and coding by allowing you to write markdown and publish it directly to Notion. This approach aligns perfectly with the idea that docs should be part of the same ecosystem as your code, working together instead of in silos. With its internal, password-protected, or public options, you have the flexibility to choose how to share your knowledge. I really appreciate how Notation eliminates the headache of logging into separate services to update docs post-deployment. This workflow not only enhances productivity but also reduces friction for engineers who want to focus on coding instead of juggling between platforms. Moreover, the inclusion of Notion's AI and robust search features is a significant boon—documentation should be easy to find, and with Notation, you won’t have to concern yourself with complex frameworks like React or Docusaurus. This keeps everything straightforward, so anyone, even non-engineers, can access your documentation without hurdles. The emphasis on making docs searchable and subject to a review process just like code makes it a solid choice for maintaining high-quality documentation. Overall, Notation seems to think about documentation the way engineers do, and it’s refreshing!
Loving the focus on seamless integration with Notion, @kayolord! The design philosophy really resonates with how documentation should be part of the development process, not a separate entity. The emphasis on Markdown as the only front-end framework simplifies things so much. We're often bogged down by complex setups and tools that can take away from actual coding. Searchability is critical too—you're spot on that a good search feature can save so much time! It’s great to see a product that not only prioritizes accessibility for non-engineers but also keeps everything under one roof for those who are. Can’t wait to see how Notation evolves further; I'm definitely considering it for my next project! Upvoted!
Hey Kristian, How does Notation handle conflicts if multiple team members are updating docs simultaneously? Are there plans to support other platforms besides Notion in the future? Congrats on the launch!