47 lines
2.4 KiB
Markdown
47 lines
2.4 KiB
Markdown
|
|
Yes, there are even documentations about documentation which is itself a bit of a paradox when you think about it. But there are many documentation sources out today for just that purpose.
|
|
|
|
In fact Obsidian itself is a fantastic documentation source. It serves to explain and give tutorials for me. Just stick with one though.
|
|
|
|
Documentation Sources:
|
|
- Refer to [Alt. Obsidian](obsidian://open?vault=enter&file=Coding%20Tips%20(Classical)%2FProject%20Vault%2FAbout%20Obsidian%2FAlt.%20Obsidian) too!
|
|
- Wikipedia
|
|
- the original documentation site
|
|
- this generally documents **concepts** though and serves as an encyclopedia for documentation on certain topics.
|
|
- MediaWiki powers wikipedia
|
|
- there are several such "wiki" based documentations
|
|
- Notion
|
|
- Notion has a wiki template too
|
|
- Notion documents more adaptively and is user-friendly for many kinds of adaptation from **code** to task-assigning.
|
|
- Obsidian
|
|
- Especially with Obsidian Publish it can turn into a great wiki
|
|
- Google Docs
|
|
- you can now publish anything made in gDocs to the web!
|
|
- MkDocs
|
|
- [Wiki.js ](https://docs.requarks.io/install/linux) - a powerful new way to create documentation
|
|
- [Quarto](https://quarto.org/docs/websites/website-navigation.html) is a documentation software for academics built on top of pandocs
|
|
- There is a great tutorial for converting from Hugo/Jekyll based static site generators to Quarto [via this site.](https://www.andreashandel.com/posts/2022-10-01-hugo-to-quarto-migration/index.html)
|
|
- nvALT - a simple note-taking utility to store your notes in markdown
|
|
- [Doxygen](https://www.doxygen.nl/index.html) - generates documentation from source code!
|
|
- in fact they even provide a list of all other sites on [documentation for code](https://www.doxygen.nl/links.html) sources!
|
|
- [NaturalDocs](https://www.naturaldocs.org/documentation/#)
|
|
![[Pasted image 20231127115554.png]]
|
|
|
|
|
|
Writing/Blogging Platforms:
|
|
- medium
|
|
- substack
|
|
- [write.as](https://write.as)
|
|
|
|
---
|
|
|
|
### Documentation Themes
|
|
|
|
The themes themselves or the front matter for documentation is certainly worth mentioning. Of course you can also just skip that whole process and go directly into simple html design. But aesthetics do matter at the end of the day. Here are notable themes.
|
|
|
|
- This [Re-learn Hugo Theme](https://mcshelby.github.io/hugo-theme-relearn/basics/index.html) for docs
|
|
- utilized by [localai.io ](https://localai.io)
|
|
|
|
|
|
|
|
#docs |