Notepad/enter/Coding Tips (Classical)/Terminal Tips/Languages/Documentation.md

28 lines
1.4 KiB
Markdown
Raw Normal View History

2023-07-17 14:33:07 +00:00
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:
2023-07-17 14:35:30 +00:00
- Wikipedia
- the original documentation site
- this generally documents **concepts** though and serves as an encyclopedia for documentation on certain topics.
2023-07-17 14:33:07 +00:00
- Notion
2023-07-17 14:35:30 +00:00
- Notion has a wiki template too
- Notion documents more adaptively and is user-friendly for many kinds of adaptation from **code** to task-assigning.
2023-07-17 14:33:07 +00:00
- Obsidian
2023-07-17 14:35:30 +00:00
- Especially with Obsidian Publish it can turn into a great wiki
2023-07-17 14:33:07 +00:00
- Google Docs
2023-07-17 14:35:30 +00:00
- you can now publish anything made in gDocs to the web!
- MkDocs
- [Quarto](https://quarto.org/docs/websites/website-navigation.html) is a documentation software for academics built on top of pandocs
---
### 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)
-