standards-and-practices
Asciidoctor
standards-and-practices | Asciidoctor | |
---|---|---|
3 | 35 | |
63 | 4,647 | |
- | 0.7% | |
1.9 | 8.7 | |
9 months ago | about 1 month ago | |
Shell | Ruby | |
- | MIT License |
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.
standards-and-practices
-
How do you go about a PR as a Senior Developer?
Its a bit overkill in my opinion, but something like https://github.com/Shift3/standards-and-practices or some public place where everyone is part of the standard process that can then be pointed to later on helps out tremendously.
-
What's your documentation stack?
Its nowhere near perfect but we maintain a Standards and Practice repo here: https://github.com/Shift3/standards-and-practices works well when people get onboarded and have questions regarding what our standards are.
-
Can someone recommend me books, resources, etc. to help
A while back my company was looking at extending our standards to include some recommended reading. Take a look if you would like: https://github.com/Shift3/standards-and-practices/issues/170
Asciidoctor
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
AsciidocFX, is an open-source, cross-platform editor that provides an exceptional user experience and a comprehensive set of features for working with Asciidoc files. Though Asciidoctor provides these capabilities, not everyone will be comfortable enough to work in the commandline or shell setting that's where AsciidocFX comes to the rescue. Let's explore some of the key capabilities that make AsciidocFX stand out.
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ).
-
[DEV][App Release] Markor 2.11 adds AsciiDoc and CSV Support
AsciiDoc File support. ( #1876, #808, #2022)
-
Good software/SaaS for Technical Documentation CMS
If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/
-
Documentation generators and custom syntax highlighting
I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:
-
I wish Asciidoc was more popular
AsciiDoc is so close to being good. It slam dunks Markdown, but they just have a few nagging issues that they refuse to fix, for 9 years now:
https://github.com/asciidoctor/asciidoctor/issues/1087
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax highlighting), as well as Font Awesome (for icons). Although Asciidoctor is written in Ruby, that does not mean you need to know Ruby to use it. Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js. You can choose any one of three Asciidoctor processors (Ruby, JavaScript, Java/JVM) and get the same experience. You can also use the Asciidoctor Maven Plugin to convert your Asciidoc documentation using Asciidoctor from an Apache Maven build.
-
Designing Go Libraries: The Talk: The Article
asciidoctor for writing
-
Docs as code vs a tool that can work with .md and xml?
If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/
- Diving deeper into custom PDF and ePub generation
What are some alternatives?
php-pre-commit - Pre-commit git hook to help keep code within PHP standards.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
pyreports - pyreports is a python library that allows you to create complex report from various sources
Zettlr - Your One-Stop Publication Workbench
black - The uncompromising Python code formatter
plantuml - Generate diagrams from textual description
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
ruff - An extremely fast Python linter and code formatter, written in Rust.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
markdown-to-confluence - Syncs Markdown files to Confluence
hugo-PaperMod - A fast, clean, responsive Hugo theme.