https://github.com/victorb/crux-site-mock
A redacted clone of the private `crux-site` repo to enable people to preview and contribute to the Crux documentation sections of http://opencrux.com
https://github.com/victorb/crux-site-mock
Last synced: 4 months ago
JSON representation
A redacted clone of the private `crux-site` repo to enable people to preview and contribute to the Crux documentation sections of http://opencrux.com
- Host: GitHub
- URL: https://github.com/victorb/crux-site-mock
- Owner: victorb
- Created: 2020-10-26T13:26:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-26T12:06:11.000Z (over 5 years ago)
- Last Synced: 2026-02-27T00:56:47.522Z (4 months ago)
- Homepage:
- Size: 1.15 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mock `ui-bundle.zip`
A redacted Antora bundle build from the private `crux-site` repo, to enable people to preview and contribute to the Crux documentation sections of http://opencrux.com
## Usage
Copy `ui-bundle.zip` to `docs/crux-site/ui-bundle.zip` and from within `docs` run `bin/build.sh` - the generated static site is created under `docs/build`.
The `scss` src directory has also been included for anyone looking to contribute to styling changes (requires `sass`). The generated stylesheets can be merged into the generated static site directories.
## Updating (internal-only)
To prepare a new mock version from the private https://github.com/juxt/crux-site repo:
`cd ui/images/`
`find . -type f -not -name 'navbar-logo.svg' -print0 | xargs -0 rm --`
and
`cd ui/layouts/`
`find . -type f -not -name '404.hbs' -not -name 'default.hbs' -print0 | xargs -0 rm --`
Also check to make sure nothing else recently added might need removing too, and update these instructions as needed.