Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing: Building docs locally #996

Closed
Tracked by #972
StackScribe opened this issue Mar 8, 2023 · 0 comments · Fixed by #1484
Closed
Tracked by #972

Contributing: Building docs locally #996

StackScribe opened this issue Mar 8, 2023 · 0 comments · Fixed by #1484
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Mar 8, 2023

Transcribe information from the "Building the documentation locally" and "Building markdown files without Hugo" sections of the docs/CONTRIBUTING.md file.

Include a link in the docs/CONTRIBUTING.md file to this material.

Coordinate with the owner of #999 to determine how to handle info about the markdownlint tool. A couple specific items to be sure are included somewhere:

  • The markdownlint README file lists the rules that are checked by the tool, with links to supporting documentation that gives details of the style that is being enforced.
  • Many (most?) of the errors identified by markdownlint can be fixed automatically by running the following command from the directory where you run Hugo locally:
    make markdownlint-fix
    
    You must then git add, commit, and push the changes made by markdownlintto clear the CI build errors for your PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Archived in project
1 participant