https://github.com/kicksecure/kicksecure-packages
https://github.com/kicksecure/kicksecure-packages
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kicksecure/kicksecure-packages
- Owner: Kicksecure
- License: mit
- Created: 2023-04-11T21:36:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-17T15:22:32.000Z (about 3 years ago)
- Last Synced: 2025-12-19T14:39:30.877Z (6 months ago)
- Language: HTML
- Size: 2.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
This repository creates a static HTML site for Kicksecure packages in the repository [kicksecure-packages-static](https://github.com/Kicksecure/kicksecure-packages-static). It uses markdown data generated by [package_parser](https://github.com/derivative-maker/package_parser) to create the site.
It is based on the Jekyll theme `just-the-docs`
## Setup
1. Install a working version of ruby 3
2. Install bundler by running `gem install bundler`
3. `bundle install`
3. Copy the `./docs` folder from `package_parser` in to the `./docs` folder within this repository
4. Run `bundle exec jekyll build`
5. Move the `_site` folder to your desired location to view the static site
## CI Setup
In the github settings for this repository, an environment variable `ACCESS_TOKEN` must be set for Github actions. This variable must correspond to a personal access token with read and write priviledges that can be created in your personal settings.
### WARNING
If you push any changes in `./docs` to main, it will automatically change the static site in the [kicksecure-packages-static](https://github.com/Kicksecure/kicksecure-packages-static). The docs folder should only contain changes generated by the `./publish-site.sh` script in the [package_parser](https://github.com/derivative-maker/package_parser/blob/main/build-site.sh) repository.