Skip to content

[ISSUE] TOC filename numbering scheme is too strict, has a ripple effect on file / directory namings when needing to insert a new section in the beginning / middle #28

@lestephane

Description

@lestephane

Do you have an idea to improve the project? Please describe.

Consider the following file listing:

$ tree -P '*.md' -L 1 aws-lambda
aws-lambda
├── 01_TheCaseForLambda.md
├── 02_MinimumViableFunction.md
├── 03_AddingLambdaSupport.md
├── 04_DeployingOurFunction.md
├── 05_UpdatingOurFunction.md
├── 06_CleaningUp.md
...

If I now want to add an introduction before 01_TheCaseForLambda.md, I have no other option than to rename all the section files and directories that come after it.

Playing tricks with the filename does not work:

Tried double underscore _

[INFO] DocuMaid started
[ERROR] DocuMaid finished with 2 errors.
[ERROR] [TOC] Same TOC indices[1] used by multiple files [01_TheCaseForLambda.md, 01__Introduction.md] (in path /home/lestephane/GitRepos/quantummaid-tutorials/aws-lambda)
[ERROR] Found [Nav] tags without a [TOC]

Tried to double 01_:

[INFO] DocuMaid started
[ERROR] DocuMaid finished with 2 errors.
[ERROR] [TOC] Same TOC indices[1] used by multiple files [01_01_Introduction.md, 01_TheCaseForLambda.md] (in path /home/lestephane/GitRepos/quantummaid-tutorials/aws-lambda)
[ERROR] Found [Nav] tags without a [TOC]

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions