采用
WriterSide 是一个文档编写工具,它提供了一个Docs-as-code的工作流, 支持Markdown和XML格式,可以自动化文档质量,提供实时预览,API文档生成等功能。
特性:
- Docs-as-code pipeline
- Markdown and XML combined
- Doc quality automation
- Live preview
- Single-source
- AI support
WriterSide & Friends
- gitbook: https://www.gitbook.com/
- MkDocs: https://www.mkdocs.org/
- mdBook: https://github.com/rust-lang/mdBook
- Docsy: https://www.docsy.dev/
- Docusaurus: https://docusaurus.io/
- Starlight: https://starlight.astro.build/
- Sphinx: https://www.sphinx-doc.org/en/master/
References
- WriterSide: https://www.jetbrains.com/writerside
- Docs as Code: https://www.writethedocs.org/guide/docs-as-code/
- GitHub Markdown: Basic writing and formatting syntax
- New Markdown extension: Alerts provide distinctive styling for significant content