Skip to content

Add a way to ignore the source link file present in the SUMMARY.md while including the link. #2573

Open
@AdrienDerobert

Description

@AdrienDerobert

Problem

I want to add an auto generated part of a documentation that I am writing but the tool I am using generates HTML so i want to have a link to the page generated by the tool in the sidebar. Problem the book won't build because the source doesn't exist.

Proposed Solutions

Solution 1: Add a syntax to the SUMMARY parser to make it so it will ignore the file behind the link but generate the the link .

Solution 2: If the link is not a md file it inserts the link into the sidebar without checking for a file in the source directory and leave it to the user to ensure the file at the link destination is present in the output directory.

Solution 3: Add a way to hook into the serve process to have a post build script run before the files are served where i can fix the generated part with a bash script.

Notes

Currently to include my generated part i put an empty index.md file where the index.html would end up in the finished build but the problem arise when running mdbook serve where the generated HTML is systematically replaced by the empty file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-enhancementCategory: Enhancement or feature request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions