apex / apex/static

Feature Request: Generating documentation from a single README.md file

Open
#33 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
290
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Hi,

First of all, thanks for the great project! It's one of the best tools for generating websites with documentation I've found so far.

I think, it would be nice to have a feature, which allows to generate documentation from a single `README.md` file. I have a few small projects with documentation in a single file and I'd like to keep it like this for now. On the other hand, I'd like to use static to generate website with documentation, but in order to do that, I have to reorganize my documentation. I think, possibility of generating documentation in two ways (from multiple files and from a single file) would be useful.

Regards,
Piotr

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.