billryan / billryan/algorithm-exercise
add sections automatically for gitbook SUMMARY.md from *.md source files
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 867
- PR merge metrics
- No merged PRs in 30d
Description
Add new sections by [GitbookIO editor](https://github.com/GitbookIO/editor) is quite simple, but sometimes you may forget to add sections in [SUMMARY.md](https://github.com/billryan/algorithm-exercise/blob/master/SUMMARY.md).
It is easy to parse the title of source .md files and add it to the appropriate chapter position. I will implement this feature with Python.
Contributor guide
Research direction
Start by reading SUMMARY.md and the existing source .md files to understand their chapter structure and title format. Then determine how a Python tool would identify missing sections and place them in the appropriate chapter; done means newly added source files are represented in SUMMARY.md without disturbing existing ordering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100