this post was submitted on 29 Jul 2023
21 points (100.0% liked)

Programming

13271 readers
2 users here now

All things programming and coding related. Subcommunity of Technology.


This community's icon was made by Aaron Schneider, under the CC-BY-NC-SA 4.0 license.

founded 1 year ago
MODERATORS
 

Hi! I'm learning code: I've been doing a bit of JavaScript, and now i'm switching to TypeScript before going through frameworks.

One thing i'm quite missing is the possibility to have a personal documentation environment: something that let me write documentation on what i'm learning WHILE writing code and following my courses, using something like typedoc or javadoc.

I have been using Obsidian, that is good for markdown content, and i can generate docs with typedoc-markdown-plugin that i can then open on obsidian. However i would like to have both my code and my docs all togheter, not for a single project but for all the courses and little projects i'm doing, having it all togheter stored in one place, and possibly being able to share it as a portfolio in the future.

I don't specifically need to show the code in this environment, i just need the docs to be visible and to be pointing to the specific sections of the environment holding my code (wich can be github links like the ones that typedoc automatically add). I would like to have one directory for each project containing both my code and my docs.

Something like a programming digital garden! But integrated with tools that generate documentation from my code.

I've tried the typedoc-hugo-plugin to host a static docs website with Hugo, but it's not quite mantained and came with a lot of bugs, like broken links.

I'm trying to use Docusaurus and docusaurus-plugin-typedoc; it looks quite good, however i understood it is designed more to hold documentation for a single big project than for a series of small (learning oriented) projects. You need to configure each extra (more than one) docs folder to get it work properly, which is something i would avoid, if possible.

I love all the TSdoc standard thing, but i don't really know how to put everything togheter.

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 5 points 11 months ago (3 children)
[–] [email protected] 2 points 11 months ago* (last edited 11 months ago) (1 children)

I’ve looked at the webpage, a blog post “How I use HackMD in FOSS”, the intro to the documentation, the features page in the documentation, and I still can’t find out what this thing is supposed to be doing. Is it a wiki? Is it a tool to extract documentation from source code?

[–] [email protected] 2 points 11 months ago

Just markdown docs really in a simple format to export for documentation.

load more comments (1 replies)