Add API docs to Logux website
We need an API doc like we have for Node.js.
I will like to have the same design for API docs across all languages. So we will need to write a custom HTML generator. It is hard, but I will do most of the work.
I need a help only to:
- Create a Make task to generate a JSON file of API.
- Give me a set of commands from
git cloneto get that JSON file of API.
@ai So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description? Do we talk about auto-gen documentation?
Where I can find the schema of JSON objects you will expect?
So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description?
Every project will generate own file with JSON (and they can use different schema). Then by JS converter, I will convert it to the same HTML.
Here is how I do it for TypeDoc (I use JS object instead of JSON in the case of TypeScript):
Where I can find the schema of JSON objects you will expect?
I will write a convertor from any JSON schema.
Something like
rel https://github.com/logux/logux.io/pull/22
Make sure make docs works properly from the ENV