Skip to content

v0.1.0
Compare
Choose a tag to compare
@github-actions github-actions released this 07 Oct 05:44
0.1.0
86b2632
This commit was signed with the committer’s verified signature.
thecodrr Abdullah Atta
GPG key ID: 28F2DB4CA334E143
Learn about vigilant mode.

Why Docgen?

This is the first release after forking off of Doctave which seems to have stagnated. Even though the original author plans to move it to a separate personal repo, it seems it is on low priority. Seeing how it has stagnated, I have decided to continue this amazing project under a different name: Docgen. So "Why not just push the changes upstream?"_ Because I am taking a different approach to this project. I want this to be simple yet feature-full. Here are some infrastructural changes I have made:

  • Moved the markdown library inside the main project so it's just one repo. This allows for faster development of new features.
  • Markdown tests are now snapshot based thanks to insta.rs. This means I don't have to think about the results, just the input.
  • Do not introduce new syntax into markdown. This hasn't been completed yet. I intend to change the callouts syntax to use quotes or something else. This is absolutely necessary to allow non-docgen editors to view & edit the markdown files without all the garbage.

With that being said, let's move on to what new features I have added.

⭐ New stuff

  1. Symlink paths are now supported. This was a trivial change but HUGE — for example, the docs for docgen now share the main README.md file.
  2. Tabs are now here. (this was the only limitation & also the reason I forked docgen). The best thing is tabs don't introduce yet another new syntax. The parser implicitly understands when you use # [Tab title](#/tab/tab-id) that you want tabs. Everything else is the same.

🐛 Fixes & improvements

  1. Dark/light theme are now more consistent looking thanks to CSS variables.
Assets 5
Loading