Asciidoctor
hubris
Our great sponsors
Asciidoctor | hubris | |
---|---|---|
34 | 32 | |
4,638 | 2,784 | |
1.6% | 6.3% | |
8.9 | 9.4 | |
20 days ago | 2 days ago | |
Ruby | Rust | |
MIT License | Mozilla Public License 2.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.
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:
-
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.
hubris
-
Who killed the network switch? A Hubris Bug Story
I wouldn't put this comment here. It's not just some detail of this function; it's an invariant of the field that all writers have to respect (maybe this is the only one now but still) and all readers can take advantage of. So I'd add it to the `TaskDesc::regions` docstring. [1]
[1] https://github.com/oxidecomputer/hubris/commit/b44e677fb39cd...
-
Oxide: The Cloud Computer
With respect to Hubris, the build badge was, in turns out, pointing to a stale workflow. (That is, the build was succeeding, but the build badge was busted.) This comment has been immortalized in the fix.[0]
With respect to Humility, I am going to resist the temptation of pointing out why one of those directories has a different nomenclature with respect to its delimiter -- and just leave it at this: if you really want to find some filthy code in Humility, you can do much, much better than that!
[0] https://github.com/oxidecomputer/hubris/commit/651a9546b20ce...
-
Barracuda Urges Replacing – Not Patching – Its Email Security Gateways
A lot of questions in there! Taking these in order:
1. We aren't making standalone servers: the Oxide compute sled comes in the Oxide rack. So are not (and do not intend to be) a drop in replacement for extant rack mounted servers.
2. We have taken a fundamentally different approach to firmware, with a true root of trust that can attest to the service processor -- which can turn attest to the system software. This prompts a lot of questions (e.g., who attests to the root of trust?), and there is a LOT to say about this; look for us to talk a lot more about this
3. In stark contrast (sadly) to nearly everyone else in the server space, the firmware we are developing is entirely open source. More details on that can be found in Cliff Biffle's 2021 OSFC talk and the Hubris and Humility repos.[0][1][2]
4. Definitely not vaporware! We are in the process of shipping to our first customers; you can follow our progress in our Oxide and Friends podcast.[3]
[0] https://www.osfc.io/2021/talks/on-hubris-and-humility-develo...
[1] https://github.com/oxidecomputer/hubris
- Do you use Rust in your professional career?
-
Spotting and Avoiding Heap Fragmentation in Rust Applications
everywhere, for example in https://github.com/oxidecomputer/hubris/search?q=dyn
Is Box really allocating here? Is the "Rust By Example" text incomplete?
Then I had to stop learning Rust for other reasons, but this doubt really hit me at the time.
-
What's the coolest thing you've done with Neovim?
I work on an embedded OS in Rust (Hubris) that has a very bespoke build system. As part of the build system, it has to set environmental variables based on (1) the target device and (2) the specific "task"; this is an OS with task-level isolation, so tasks are compiled as individual Rust crates.
-
TCG TPM2.0 implementations vulnerable to memory corruption
Oxide Computer told some storied about the difficulty of bring up of a new motherboard, and mentioned a lot of gotcha details and hack solutions for managing their AMD chip.
They talked about their bring up sequence, boot chain verification on their motherboard, and designing / creating / verifying their hardware root of trust.
I heard mention of this on a podcast recently, trying to find the reference.
I'm pretty sure it was [S3]
- "Tales from the Bringup Lab" https://lnns.co/FBf5oLpyHK3
- or "More Tales from the Bringup Lab" https://lnns.co/LQur_ToJX9m
But I found again these interesting things worth sharing on that search. https://oxide.computer/blog/hubris-and-humility, https://github.com/oxidecomputer/hubris
Search 1 [S1], Trammell Hudson ep mentioning firmware (chromebook related iirc) https://lnns.co/pystdPm0QvG.
Search 2 [S2], Security, Cryptography, Whatever podcast episode mentioning Oxide and roots of trust or similar. https://lnns.co/VnyTvdhBiGC
Search links:
[S1]: https://www.listennotes.com/search/?q=oxide+tpm
[S2]: https://www.listennotes.com/search/?q=oxide%20and%20friends%...
[S3]: https://www.listennotes.com/search/?q=oxide%20and%20friends%...
- Well-documented Embedded dev board for video, ethernet, usb, file IO, etc
-
OpenAI Used Kenyan Workers on Less Than $2 per Hour to Make ChatGPT Less Toxic
When we started the company, we knew it would be a three year build -- and indeed, our first product is in the final stages of development (i.e. EMC/safety certification). We have been very transparent about our progress along the way[0][1][2][3][4][5][6][7] -- and our software is essentially all open source, so you can follow along there as well.[8][9][10]
If you are asking "does anyone want a rack-scale computer?" the (short) answer is: yes, they do. The on-prem market has been woefully underserved -- and there are plenty of folks who are sick of Dell/HPE/VMware/Cisco, to say nothing of those who are public cloud borne and wondering if they should perhaps own some of their own compute rather than rent it all.
[0] https://oxide-and-friends.transistor.fm/episodes/holistic-bo...
[1] https://oxide-and-friends.transistor.fm/episodes/the-oxide-s...
[2] https://oxide-and-friends.transistor.fm/episodes/bringup-lab...
[3] https://oxide-and-friends.transistor.fm/episodes/more-tales-...
[4] https://oxide-and-friends.transistor.fm/episodes/another-lpc...
[5] https://oxide-and-friends.transistor.fm/episodes/the-pragmat...
[6] https://oxide-and-friends.transistor.fm/episodes/tales-from-...
[7] https://oxide-and-friends.transistor.fm/episodes/the-sidecar...
[8] https://github.com/oxidecomputer/omicron
-
Ask HN: Examples of Microkernels?
Hubris is a microkernel-ish OS for embedded systems, and has a bunch of documentation about its design:
https://hubris.oxide.computer/reference/
It's all open-source on Github:
https://github.com/oxidecomputer/hubris
(I work at Oxide, mostly using Hubris)
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
tock - A secure embedded operating system for microcontrollers
Zettlr - Your One-Stop Publication Workbench
esp32 - Peripheral access crate for the ESP32
plantuml - Generate diagrams from textual description
meta-raspberrypi - Yocto/OE BSP layer for the Raspberry Pi boards
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
esp32-hal - A hardware abstraction layer for the esp32 written in Rust.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
ferros - A Rust-based userland which also adds compile-time assurances to seL4 development.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
l4v - seL4 specification and proofs