51–60 of 111 posts
[0]: https://www.archbee.io/ [1]: https://readme.com/
Earlier quoted context omitted.
It doesn't support search unless you rely on (pay for) Algolia? Wow, instant pass from me.
You can add your own search plugin or use another provider like Typesense. They just offer an optional free Algolia service for open-source projects on top. You can read more here: https://docusaurus.io/docs/search
The downside: quite a lot of work to create something from scratch.
The upside: I have created a playground-type API, where all options, methods & events can be tried out directly from the docs. They interact with the data grid.
For non-TypeScript codebases, we use [Docusaurus](https://docusaurus.io/).
I believe there are also plugins which can make TypeDoc output compatible with Docusaurus.
None of our docs are public at the moment, but a good example of documentation generated by TypeDoc would be Amazon's `aws-sdk`: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index...
Earlier quoted context omitted.
> live documentation: https://docs.tooljet.io The two separate hamburger menus were hard to parse at first on mobile. Do your social media links really deserve higher placement than the navigation?
You are right, placing the navigation on the sidebar is more useful than the links to GitHub and Slack.
I am frequently working on ways to document inline with the code using comments and then extract those comments during the build process to keep documentation up to date automatically. The comments are formatted as mark down so that they may be converted from code comments to stand alone mark down documents. I have also noticed that in VS Code a comment immediately preceding a type or interface declaration written in…
Are you talking about Typescript here? If so, could you give an example of how to make this happen? This sounds incredibly useful.
I do wish it supported running code snippets, but I think that can be done with some scripts and including things. (On the list, not done yet.)
Earlier quoted context omitted.
Your docs even support dark mode! Did that come out of the box or did you add that?
It comes out of the box. We are now trying to figure out how to switch screenshots based on the light/dark mode. The screenshots taken from light mode of ToolJet looks odd in Docusaurus' dark mode.
You could also write your own remark plugin, that does it for you, and would have the benefit of having more control over what happens on the github side if it was still standard markdown.
I'm using mkdocs with the material plugins [1]. I'm running it mainly for a Blockchain Education site for my labs from my course, which seems to be fine [2]. I did a fair amount of customization though, so I am running all this as mkdocs plugins, not directly from the materials project. [1] https://squidfunk.github.io/mkdocs-material/ [2] https://ethereum-blockchain-developer.com
Oh wow this looks great! Simple conversion of markdown into an opinionated simple to use really nice looking doc site.! Cheers for this :)
The free version is really nice but also very happy to pay for the 'insiders' version via GitHub donations.