Skip to content

keep auto-generated content in docs out of VCS #3713

Closed
@boneskull

Description

@boneskull

Our documentation has automatically generated sections. The content in these sections is part of the doc build and should not be in VCS.

<!-- AUTO-GENERATED-CONTENT:START (toc:maxdepth=2&bullets=-) -->
(stuff)
<!-- AUTO-GENERATED-CONTENT:END -->

Should not be modified when running npm start docs.

Instead, the build should be run against a transient copy of the file. That means:

  1. Copy docs/index.md to a temp location
  2. Run the preprocess script against the temp copy
  3. Ensure Eleventy generates documentation from the temp copy
  4. Remove the temp copy

Take care not to deploy the temp copy itself; Eleventy should deploy HTML only, and no markdown.

(This also applies to tutorials found in the API docs, which are in incoming pull request #3655; don't worry about these for now.)

Activity

added a commit that references this issue on Feb 16, 2019
558cf7d
added a commit that references this issue on Feb 16, 2019
61b6bb4
added a commit that references this issue on Feb 27, 2019
ccc431f
added a commit that references this issue on May 21, 2020
e07cf0f
added a commit that references this issue on Feb 28, 2024
ca0daa3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @boneskull

        Issue actions

          keep auto-generated content in docs out of VCS · Issue #3713 · mochajs/mocha