https://github.com/bndtools/bndtools.github.io
Bndtools.org Main Site
https://github.com/bndtools/bndtools.github.io
bndtools
Last synced: 10 months ago
JSON representation
Bndtools.org Main Site
- Host: GitHub
- URL: https://github.com/bndtools/bndtools.github.io
- Owner: bndtools
- License: epl-1.0
- Created: 2011-11-30T18:53:06.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2025-08-18T19:35:43.000Z (10 months ago)
- Last Synced: 2025-08-18T21:28:22.207Z (10 months ago)
- Topics: bndtools
- Language: HTML
- Homepage: https://bndtools.org
- Size: 49.7 MB
- Stars: 5
- Watchers: 11
- Forks: 20
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Bndtools.org Main Website
=====================
This repository holds the bndtools.org website hosted at [https://bndtools.org][bndtools].
This web site is maintained as markdown and turned into HTML by [Jekyll][jekyll]
using [GitHub Pages](https://help.github.com/articles/what-are-github-pages/).
## Local development
- install ruby 2.7
- call `./run.sh` on the commandline
This should install jekyll and start a local webserver at:
- http://127.0.0.1:4000/
Start editing markdown `.md` files. Jekyll will auto-detect changes and reload the website. Some changes require a restart (e.g. changes to `_config.yml`)
## Local development with Pagefind search
We use https://pagefind.app/ for our search field full text search.
But it is currently not automatically working when using `./run.sh` above, because it works on the
actual build-output on the `_site` folder (which contains the actual `.html` pages).
To test the search locally based on the `_site` folder content, run:
`./run-pagefind-linux.sh`
or
`run-pagefind-macos.sh`
depending on which operating system you are using.
The result should look like:
`Serving "_site" at http://localhost:1414`
The script will download and execute the pagefind executable binary after the build.
Then it will start a small server where you test the result.
Note, that this is different than the `./run.sh` and does not support real-time editing of the content.
Feel free to adjust / extend the start-scripts if you have a different architecture
or to use a different `pagefind` version.
### pagefind for production build via github actions
See the files `.github/workflows/cibuild.yml` and `.github/scripts/docs.sh` for how
building the site and executing `pagefind` is done in the final build on github.
### CSS Styling for Code Highlighter
- jekyll uses `rouge` code highlighter
- see `_config.yml` and section `syntax_highlighter_opts`
- also see this website https://jekyll-themes.com/brazacz/rouge-themes for examples
- rouge is compatible with and can use 'pygments' styles (see https://pygments.org/styles/)
- these styles can be generated with the command
The following commands locally will help to generate the .css files for the pygment styles:
```
gem install rouge
# show a list of supported styles
rougify help style
# go to the css folder
cd css
# generate the css
rougify style monokai > monokai.css
```
Then reference the `.css` file in `_includes/head.html `
## Feedback
Feedback is always welcome.
For general discussions use the list.
We also have the list for discussions on the development of bndtools.
Bugs and issues for the [https://bndtools.org][bndtools] website should go to
## Contributing
Want to hack on the bndtools.org website? See [CONTRIBUTING.md](CONTRIBUTING.md) for information on building, testing and contributing changes.
They are probably not perfect, please let us know if anything feels
wrong or incomplete.
## License
The contents of this repository are made available to the public under the terms of the [Eclipse Public License v1.0](http://www.eclipse.org/legal/epl-v10.html).
[bndtools]: https://bndtools.org
[jekyll]: http://jekyllrb.com/