isocpp / isocpp/CppCoreGuidelines
How to build this site locally? For Offline usage
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 45.3k
- Forks
- 5.6k
- PR merge metrics
- No merged PRs in 30d
Description
I know that generating a .pdf file would lead to:
- Not current content/guidelines
- Some aesthetic features not present (Syntax Highlighting, nice TOC on the left)
But when building the site locally we can still use features of the website,
and If we want to update it we just need to execute git pull on the cloned repository,
I've looked on the build workflow file: https://github.com/isocpp/CppCoreGuidelines/blob/master/.github/workflows/build.yml
But executing make -k in ./scripts folder only generates .cpp files
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/workflows/build.yml and the scripts directory, then compare the workflow commands with the reported result of running make -k. Done means documenting the supported local or offline build steps and the resulting website features, or clearly recording any limitation found.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, github-actions
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100