https://github.com/jcbhmr/cmakebyexample.jcbhmr.com

🔰 cmakebyexample.jcbhmr.com website
https://github.com/jcbhmr/cmakebyexample.jcbhmr.com

byexample c cmake cpp help-wanted looking-for-contributors vitepress website

Last synced: 24 days ago
JSON representation

🔰 cmakebyexample.jcbhmr.com website

• Host: GitHub
• URL: https://github.com/jcbhmr/cmakebyexample.jcbhmr.com
• Owner: jcbhmr
• License: cc-by-4.0
• Created: 2023-09-27T16:54:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-31T03:17:17.000Z (29 days ago)
• Last Synced: 2024-12-31T03:25:07.090Z (29 days ago)
• Topics: byexample, c, cmake, cpp, help-wanted, looking-for-contributors, vitepress, website
• Language: JavaScript
• Homepage: https://cmakebyexample.jcbhmr.com/
• Size: 791 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    You're probably looking for cmakebyexample.jcbhmr.com 😉



## Development

![mdBook](https://img.shields.io/static/v1?style=for-the-badge&message=mdBook&color=000000&logo=mdBook&logoColor=FFFFFF&label=)

![CMake](https://img.shields.io/static/v1?style=for-the-badge&message=CMake&color=064F8C&logo=CMake&logoColor=FFFFFF&label=)

Make sure you've installed [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html) and [CMake](https://cmake.org/download/). You'll also need to install [mdbook-cmdrun](https://github.com/FauconFan/mdbook-cmdrun). Run `mdbook serve` to see the live preview.

The custom `theme/highlight.js` is needed because the default mdBook `highlight.js` doesn't include the `cmake` language. The current custom build includes [all of the mdBook defaults](https://rust-lang.github.io/mdBook/format/theme/syntax-highlighting.html#supported-languages) plus `cmake`. Generate it using https://highlightjs.org/download and use the `./highlight.min.js` file from the resulting `.zip` download.

To create a new example ("Cool feature" in this example):

1. Add it to `src/SUMMARY.md` like `- [Cool feature](cool-feature/README.md)`.

2. Create a `src/cool-feature/README.md`.

3. Create your example in `src/cool-feature/`. Add a bunch of comments _in the code files_ so that they are visible on the website and when viewing the file in an IDE.

4. `{{#include filename.txt}}` any interesting files in `src/cool-feature/README.md`.

5. Add any shell commands to interact with the example to the `src/cool-feature/README.md`. Make sure to document them.

6. (Optional) Use `` or similar inside a `` ``` `` code block to run that command and use its output at build time.

7. Create a corresponding `.devcontainer/cool-feature/devcontainer.json` that will open the example's folder. Add any necessary dependencies to the dev container.

8. Add an "Open in Codespaces" button to the `src/cool-feature/README.md`.