https://github.com/dfinity/antora-sdk
Repo for website collaboration - antora project file and ui project files
https://github.com/dfinity/antora-sdk
Last synced: 8 months ago
JSON representation
Repo for website collaboration - antora project file and ui project files
- Host: GitHub
- URL: https://github.com/dfinity/antora-sdk
- Owner: dfinity
- License: mpl-2.0
- Created: 2020-02-05T16:54:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:45:09.000Z (almost 3 years ago)
- Last Synced: 2024-04-18T06:58:07.660Z (about 2 years ago)
- Language: CSS
- Size: 9.55 MB
- Stars: 9
- Watchers: 44
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Customizing the UI for DFINITY Internet Computer Documentation
This project uses [Antora](https://antora.org) to generate an interface for the DFINITY Internet Computer [SDK site](https://sdk.dfinity.org). The [dfinity-docs-playbook](https://github.com/dfinity-lab/dfinity-docs-playbook) pulls in the `ui-bundle.zip` file from this repo and the documentation from the the following repos to generate the static documentation site:
- [dfinity/docs](https://github.com/dfinity/docs)
- [dfinity/motoko-base](https://github.com/dfinity/motoko-base)
- [dfinity/candid](https://github.com/dfinity/candid)
- [dfinity-lab/motoko](https://github.com/dfinity-lab/motoko)
## Development
Run `gulp preview` to run the project locally. Doing this uses the sample documentation (not the docs defined in [dfinity-docs-playbook](https://github.com/dfinity-lab/dfinity-docs-playbook) ).
## Building the UI
Once you're happy with the changes, run `gulp-bundle` to generate a new `ui-bundle.zip` folder. The [dfinity-docs-playbook](https://github.com/dfinity-lab/dfinity-docs-playbook) repo references this zip file on the `master` branch.
## Deployments
Deployments are handled automatically through netlify whenever commits to master happen on [dfinity-docs-playbook](https://github.com/dfinity-lab/dfinity-docs-playbook). Since this repo doesn't trigger netlify deployments, you'll have to manually kick off a new deployment from Netlify.
#### Note
If you want to preview the site with actuall content before deploying, you can run `antora antora-playbook.yml` in [dfinity-docs-playbook](https://github.com/dfinity-lab/dfinity-docs-playbook) which will generate the site.
## Further Antora Documentation
[Further Antora Documentation](https://gitlab.com/antora/antora-ui-default)