Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidm42/navigo
Quick site template project for you to quickly build minimal, responsive and static quick link pages
https://github.com/davidm42/navigo
Last synced: about 2 months ago
JSON representation
Quick site template project for you to quickly build minimal, responsive and static quick link pages
- Host: GitHub
- URL: https://github.com/davidm42/navigo
- Owner: DavidM42
- License: mit
- Created: 2021-02-18T20:16:26.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-18T21:17:36.000Z (almost 4 years ago)
- Last Synced: 2024-10-07T07:21:10.910Z (4 months ago)
- Language: Python
- Size: 1.4 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Navigo
This quick site template project allows you to quickly build minimal, responsive and static quick link pages.
**No more remembering and [navigating](https://www.online-latin-dictionary.com/latin-english-dictionary.php?parola=navigo) URLs.**
The page even uses a `manifest.json` for you to install it as Progressive-Web-App to your mobile phone home screen.
## How to build manually
### Setup
Prerequisite: Your python environment is Python 3.
Install dependencies via
```sh
pip install -r requirements.txt
```
### Single build
```sh
python build.py
```
Then the build will be placed in the dist folder
### Reloader
You can also execute
```sh
python watcher.py
```
to start a live reloader which will re-build the site every time you change any template, included static file or the `links.json`.
## Ci Build and CD
The master branch is built via the `build.yaml` workflow for GitHub pages.
If successful the build is available as GitHub pages deployment for the repo.
## Editing links
The quick link page is defined via the JSON file `links.json`.
The file follows this simple schema
```jsonc
{
"title": "Navigo quick links",
"short_name:": "Navigo",
"description": "Quick navigation linking page",
"background_color": "#333",
"color": "#fff",
"links": [
{
"name": "Navigo origin",
"href": "https://www.online-latin-dictionary.com/latin-english-dictionary.php?parola=navigo",
"iconUrl": "https://www.online-latin-dictionary.com/inc/logo-dictionary.gif"
},
{
"name": "Navigo Project",
"href": "https://github.com/DavidM42/navigo",
"iconUrl": "/static/linkIcons/github120px.png"
}
]
}
```
To edit the page & links edit `links.json`.
The `iconUrl` property is optional. The software tries to automatically retrieve the favicon if not given.
For some direct-URLs which don't strictly reference web pages it needs to be linked explicitly.
Build the page locally and check if an image was automatically retrieved. If not, think about adding a favicon to your links by linking a web address to get it from or adding a local path.
Also, you might want to supply bigger logo images if the automatically found ones look bad on big screens.
## Built files
Look in the `gh-pages` branch to see all files which are built by the build script `build.py`.
## GitHub Pages Custom Domains
Since this project is automatically deployable via GitHub pages you might want to use your custom (sub-)domain for this page.
For a detailed instruction on how to set this up [look here](https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site).
## Pulling updates from template
If this template repo has been updated, and you want to incorporate these changes into your repo you can utilize this strategy [from Stack Overflow](https://stackoverflow.com/a/56577320)
```sh
git remote add template [email protected]:DavidM42/Navigo.git
git fetch --all
git merge template/master
```
After that you will have to manually solve conflicts then it should be updated.
The following times this happens you then only have to execute `git merge template/master`.
## Attribution
This project was originated from my quick link project for university [**wuel.de**](https://github.com/DavidM42/wuel).
I simplified the project for this template project and improved documentation.
The Navigo logo was drawn by a good friend of mine.