devportal
pandoc-action-example
Our great sponsors
devportal | pandoc-action-example | |
---|---|---|
3 | 1 | |
59 | 330 | |
- | 4.2% | |
9.5 | 5.1 | |
3 months ago | 3 months ago | |
PLpgSQL | ||
Creative Commons Attribution 4.0 | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
devportal
-
Migrating to Docusaurus
Hello folks, I am running a tech writing team (along with product management). I am not expert in documentation platforms. Today we have a challenging custom-built documentation platform based on Sphinx and a bunch of cobbled together technologies aiven/devportal: Resources for users of the projects on the Aiven platform (github.com) . Our documentation is in .rst markup language due to the Python focus.
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Humble brag that the last one in the list (Aiven 🦀) won 2022 DevPortal Awards in the category Best DevPortal Beyond REST Platforms. If I added a list of great docs websites but didn't include the OG, it would be a crime. Check out one of THE BEST documentation out there - Stripe Docs, built using Markdoc.
-
Automatically Open Pull Requests with GitHub Actions
You can find a list of Aiven's cloud providers on [Developer.aiven.io], which is also the portal where we host the developer documentation. To quickly retrieve a list of currently-available cloud providers, my colleague Lorna Mitchell wrote a Python script that pulls our cloud listing from the Aiven API and generates documentation, which is really cool!
pandoc-action-example
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
If you're migrating your documentation project from one markup to another, you'll want to know about projects like Pandoc. If your build process includes a process to convert markup, Pandoc can be run with GitHub Actions. If you're planning on converting Asciidoc files to Markdown, you'll have to take a detour via the XML route. The proces will be: Asciidoc ---> XML ---> Markdown.
What are some alternatives?
antora
docToolchain - a AsciiDoc Toolchain for technical Software Documentation, focused on Software Architecture Documentation
markdown-live-preview - markdown editor with live preview
gh-act - GitHub CLI Extension to run GitHub actions locally
Docusaurus - Easy to maintain open source documentation websites.
jekyll-multiple-languages-plugin - I18n support for Jekyll and Octopress
markdoc - A powerful, flexible, Markdown-based authoring framework.
Vim - The official Vim repository
commonmark-spec - CommonMark spec, with reference implementations in C and JavaScript
create-pull-request - A GitHub action to create a pull request for changes to your repository in the actions workspace
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.