Asciidoctor
obsidian-releases
Our great sponsors
Asciidoctor | obsidian-releases | |
---|---|---|
34 | 1,652 | |
4,638 | 7,956 | |
1.6% | 6.4% | |
8.9 | 9.9 | |
25 days ago | 4 days ago | |
Ruby | JavaScript | |
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.
obsidian-releases
-
I switched from Notion to Obsidian
The solution was already installed on both my computer and my phone: Obsidian.
-
Why single vendor is the new proprietary
> why does open source need to "win"
Open source does not need to win.
But your ability to be in control of your computer needs to be preserved. A proprietary fridge cannot control your diet, while a proprietary App Store can control what software you install on YOUR phone (unless you live in EU, hello DMA!). The tail wags the dog, so to speak. Proprietary software has also been shown to break user workflows or remove functions in an update while leaving users with no choice whatsoever.
One alternative to having open source win is to ensure software must come with a robust warranty and other assurances you expect from the things you buy. EU's CRA will make software vulnerabilities in WiFi routers covered by warranty, for example.
You can also ensure robust and interoperable data storage options. For example, https://obsidian.md/ stores all notes in Markdown, not holding the data hostage in case users will not like how future versions will work. GDPR actually has a provision for data portability (Art. 20), but it does not seem to have a requisite effect on the industry yet.
And until the above issues are solved, open source remains the best way to ensure that a software tail cannot wag your computer dog.
-
Ask HN: Has Anyone Trained a personal LLM using their personal notes?
[2] https://obsidian.md/
-
Replatforming from Gatsby to Zola!
So I've had my fair share of personal websites and blogs. I have built them on stacks ranging from the most basic HTML and CSS, to hosted frameworks like Wordpress and Laravel, to the more modern single page applications built in Vue and React. For a simple content blog I think you can't go wrong with a Static Site Generator though. These days I am almost exclusively writing everything in Obsidian. Which is great because its all in standard markdown format. This allows for a really neat and easy content publishing workflow.
-
Show HN: Godspeed is a fast, 100% keyboard oriented todo app for Mac
Consider making an Obsidian[^1] plugin, or writing to Obsidian-compatible Markdown files :)
[^1]: https://obsidian.md/
-
Setting Up Obsidian for Content Planning and Project Management
Obsidian is a writing application created to allow for offline / private note taking in markdown format, in an interface that looks a lot like our regular programming IDE. It is very flexible, with a good collection of community plugins that you can use to customize Obsidian to your heart contents.
-
What is Omnivore and How to Save Articles Using this Tool
Obsidian support via our Obsidian Plugin
- Tools that Make Me Productive as a Software Engineer
-
Where Is Noether's Principle in Machine Learning?
Thank you!
In the beginning, I used kognise'z water.css [1], so most of the smart decisions (background/text color, margins, line spacing I think) probably come from there. Since then it's been some amount of little adjustments. The font is by Jean François Porchez, called Le Monde Livre Classic [2].
I draft in Obsidian [3] and build the site with a couple python scripts and KaTeX.
[1] https://watercss.kognise.dev/
[2] https://typofonderie.com/fr/fonts/le-monde-livre-classic
[3] https://obsidian.md/
-
Show HN: Reor – An AI note-taking app that runs models locally
Great job!
I played around with this on a couple of small knowledge bases using an open Hermes model I had downloaded. The “related notes” feature didn't provide much value in my experience, often the link was so weak it was nonsensical. The Q&A mode was surprisingly helpful for querying notes and providing overviews, but asking anything specific typically just resulted in less than helpful or false answers. I'm sure this could be improved with a better model etc.
As a concept, I strongly support the development of private, locally-run knowledge management tools. Ideally, these solutions should prioritise user data privacy and interoperability, allowing users to easily export and migrate their notes if a new service better fits their needs. Or better yet, be completely local, but have functionality for 'plugins' so a user can import their own models or combine plugins. A bit like how Obsidian[1] allows for user created plugins to enable similar functionality to Reor, such as the Obsidan-LLM[2] plugin.
[1] https://obsidian.md/
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Trilium Notes - Build your personal knowledge base with Trilium Notes
Zettlr - Your One-Stop Publication Workbench
QOwnNotes - QOwnNotes is a plain-text file notepad and todo-list manager with Markdown support and Nextcloud / ownCloud integration.
plantuml - Generate diagrams from textual description
vimwiki - Personal Wiki for Vim
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
TiddlyWiki - A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
AppFlowy - AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.