retype
PeakRDL-html
Our great sponsors
retype | PeakRDL-html | |
---|---|---|
20 | 1 | |
947 | 43 | |
3.0% | - | |
9.0 | 5.9 | |
2 months ago | 5 months ago | |
JavaScript | JavaScript | |
GNU General Public License v3.0 or later | GNU General Public License v3.0 only |
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.
-
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.
- 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
BookStack looks interesting, but certainly one massive advantage Retype has is just installation. I can have Retype installed, my website built, and running in a browser in a 10 seconds.
With Retype, your content source are simple Markdown `.md` text files. BookStack stores your data in a database, and in order to host a website you need a PHP webserver, Maria DB, etc.
A Retype generated website can be hosted for free using GitHub Pages. The retype.com website is hosted on GitHub Pages, see https://github.com/retypeapp/retype.
Hope this helps.
One will want to be aware of the licensing for this: https://github.com/retypeapp/retype/blob/v2.2.0/LICENSE.md
"Free" as in beer, it seems
Retype builds directly off Markdown files, which you can store anywhere, including GitHub. The retype.com website is built directly from a GitHub repo, see https://github.com/retypeapp/retype
The retype.com website is also hosted on GitHub Pages. Any change that is committed to the GitHub repo will trigger the website to be rebuilt by Retype using GitHub Actions, see https://retype.com/hosting/github-pages/.
Hope this helps clarify that Retype is even more tightly integrated with GitHub, or any other source management system. You have complete control and ownership of your source content files.
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.
PeakRDL-html
-
PeakRDL-Regblock: A free & open source tool that generates SystemVerilog control & status registers (CSR) from SystemRDL
If you're interested register automation, be sure to check out some of my other projects: * systemrdl-compiler * Compiler front-end for the SystemRDL 2.0 language. Want to generate something yourself from SystemRDL input? No problem - use this language interpreter as your front-end. * PeakRDL-html * Generates dynamic and pretty looking HTML documentation * PeakRDL-ipxact * Import/export IP-XACT XML * PeakRDL-uvm * Generate a UVM register model * And a bunch of other random stuff under my SystemRDL GitHub project.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mkdocs-material - Documentation that simply works
docs - Auth0 documentation
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
wiki - The official Wiki of the selfhosted.show Podcast.
Outline - The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
pms-wiki - The aim is to share knowledge and information about building an open-source media server.
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
Gitea - Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
docuowl - 🦉 A documentation generator
mycorrhiza - 🍄📑 Filesystem and git-based wiki engine for the independent web written in Go using Mycomarkup as its primary markup language.