Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robbinparrish/git-pages-template
Git Pages Template
https://github.com/robbinparrish/git-pages-template
docker docker-compose docs git-pages git-pages-deploy git-pages-template github-pages gitlab-pages learning learning-project linux mkdocs mkdocs-material notes static-site
Last synced: 22 days ago
JSON representation
Git Pages Template
- Host: GitHub
- URL: https://github.com/robbinparrish/git-pages-template
- Owner: robbinparrish
- Created: 2024-01-19T13:45:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-16T07:51:11.000Z (12 months ago)
- Last Synced: 2024-11-12T03:31:38.525Z (3 months ago)
- Topics: docker, docker-compose, docs, git-pages, git-pages-deploy, git-pages-template, github-pages, gitlab-pages, learning, learning-project, linux, mkdocs, mkdocs-material, notes, static-site
- Language: Shell
- Homepage:
- Size: 627 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Disclaimer.
The content on this account/repository provided solely for educational and informational purposes.
It is not intended for use in making any kind of business, investment and/or legal decisions.
Although every effort has been made to keep the information up-to-date and accurate, no representations and/or warranties, express and/or implied, completeness, accuracy, reliability, suitability, and/or availability of the content.
## Git Pages Template.
This Project contains template for hosting Git pages. The documentation is generated using [mkdocs](https://www.mkdocs.org/).
Once the documentation is generated it can easily published either on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) or [Github Pages](https://docs.github.com/en/pages).
## Project Template.
This project uses [poetry](https://python-poetry.org/docs/) to manage dependencies. The below commands can be used to manage dependencies.
```bash
# Add any new dependency package.
poetry add package-name
# Remove any dependency package.
poetry remove package-name
# Update packages.
poetry update
```
This project uses [mkdocs](https://www.mkdocs.org/) for generating documentation. The below commands can be used to interact with mkdocs.
```bash
# The initial project created for this repository using below command.
poetry run mkdocs new .
# Start the mkdocs server.
poetry run mkdocs serve
# Build the documentation site.
poetry run mkdocs build
```
## Interacting with GitLab CI Pipeline.
This repository also contains a `.gitlab-ci.yml` file for building the documentation using mkdocs in GitLab CI Pipeline.
[.gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/)
### Prerequisite.
Following variables in the CI environment must be available to publish the Pages in GitLab CI.
#### Predefined environment variables.
These can be found at [GitLab Predefined Variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
##### Additional variables.
This required to create a tag using GitLab CI.
- PROJECT_ACCESS_TOKEN
#### Custom environment variables.
These are specific to the needs.
## Interacting with GitHub CI Pipeline.
This repository also contains a `.github/workflows` directory for building the documentation using mkdocs in GitHub actions. Deployed pages are available at [Git Pages Templates](https://robbinparrish.github.io/git-pages-template/).
[GitHub Actions](https://docs.github.com/en/actions)