retype
mdBook
Our great sponsors
retype | mdBook | |
---|---|---|
20 | 100 | |
977 | 16,669 | |
4.5% | 2.8% | |
8.7 | 8.6 | |
16 days ago | 10 days ago | |
JavaScript | Rust | |
GNU General Public License v3.0 or later | 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.
retype
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
How to turn a folder of markdown docs into a structured docs section in an app?
Outside of Swift, I use RetypeApp and they have a lot of inbuilt functionality. You can then generate your output directory on build, and use those HTML files as is.
- Où heberger son site web ?
-
Pushing for quality UX as an influence role
You can build pretty beautiful docs with: - https://retype.com - https://docusaurus.io - https://www.intercom.com/articles
-
GitLab Wiki or Other self-hosted wiki for Documentation
Retype is the nicest one I’ve come across in my search! Has a built in table of contents, pretty easy to create (entirely using markdown) and great support for emojis, math, containers, multi tab info panels, and proper dropdown panels.
-
Help setting up GitHub site
Are you aiming at creating something like this? With a bar on the left with folders?
- Where/ how you store and distribute documentation?
-
Is there an easy to use selfhosted wiki?
I recently set up something with https://retype.com/ and it's quite good.
-
Retype: A self-hosted and free alternative to gitbook
While gitbook does wrap the branching/merging process in a UI that is digestible by non-developers, Retype is far more powerful because you actually use GitHub (or GitLab). You have the full power of GitHub, including branching, pull-requests, issues, reviews, automation, authentication, and everything else.
For example, here's the repo for the retype.com website, see https://github.com/retypeapp/retype
The entire website is built from simple Markdown text files.
mdBook
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
gitbook - The open source frontend for GitBook doc sites
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
MkDocs - Project documentation with Markdown.
mkdocs-material - Documentation that simply works
docs - Auth0 documentation
bookdown - Authoring Books and Technical Documents with R Markdown
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
wiki - The official Wiki of the selfhosted.show Podcast.