Asciidoctor
minima
Our great sponsors
Asciidoctor | minima | |
---|---|---|
34 | 8 | |
4,641 | 3,265 | |
1.6% | 1.6% | |
8.7 | 4.1 | |
27 days ago | 28 days ago | |
Ruby | SCSS | |
MIT License | 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.
Asciidoctor
-
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
-
Mau: a lightweight markup language based on Jinja
The third system that I found was AsciiDoc, which started as a Python project, abandoned for a while and eventually resurrected by Dan Allen with Asciidoctor. AsciiDoc has a lot of features and I consider it superior to Markdown, but Asciidoctor is a Ruby program, and this made it difficult for me to use it. In addition, the standard output of Asciidoctor is a nice single HTML page but again customising it is a pain. I eventually created the site of the book using it, but adding my Google Analytics code and a sitemap.xml to the HTML wasn't trivial, not to mention customising the look of elements such as admonitions.
minima
-
Minima theme in a custom theme
you could make a _layouts directory in your project root (if you don't have one already) and copy over the minima layouts from the repo to adjust anything you need. Link: https://github.com/jekyll/minima/tree/master/_layouts
-
Designing Go Libraries: The Talk: The Article
If you prefer to use Markdown, jekyll's default theme (example) for newly scaffolded websites is also quite clean.
-
using base url with gh-pages branch.
( content originally cloned from https://github.com/jekyll/minima )
-
Building a static blog using Jekyll & Strapi
After that, we need to display the data. Jekyll uses a theme system. By default, the used theme is minima. The theme's files are not generated in the Jekyll projects, but you can override every theme's template by creating a file with the same name in the _layouts folder.
-
Minima, Mastodon, and rel="me"
Download the latest version of social.html. You'll find it here
- Need help - Jekyll site not rendering as expected on gh-pages
-
Customize Your Jekyll Website
So before doing anything, we need to look at our minima theme repository. Please make sure you look at the branch of your current version. In my case, it is the 2.5 one that is installed (you can have this info in the Gemfile file), so I am looking at the 2.5-stable branch.
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
Zettlr - Your One-Stop Publication Workbench
jekyll-theme-basically-basic - Your new Jekyll default theme.
plantuml - Generate diagrams from textual description
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
henry-jekyll - Henry: Jekyll theme meant for a gorgeous reading experience and packed with features
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
long-haul - A minimal, type-focused Jekyll theme.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
strapi-template-ecommerce - Template to create Strapi projects pre-configured for e-commerce apps