Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vanilla-os/chronos-frontend
A frontend in Vue.js for the Chronos documentation server.
https://github.com/vanilla-os/chronos-frontend
chronos documentation frontend hacktoberfest vanillaos website
Last synced: 3 days ago
JSON representation
A frontend in Vue.js for the Chronos documentation server.
- Host: GitHub
- URL: https://github.com/vanilla-os/chronos-frontend
- Owner: Vanilla-OS
- License: agpl-3.0
- Created: 2023-08-24T12:21:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-01T18:22:39.000Z (14 days ago)
- Last Synced: 2024-11-01T19:21:09.668Z (14 days ago)
- Topics: chronos, documentation, frontend, hacktoberfest, vanillaos, website
- Language: Vue
- Homepage: https://docs.vanillaos.org
- Size: 740 KB
- Stars: 6
- Watchers: 4
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Chronos Vue.js frontend
A frontend in Vue.js for the [Chronos](https://github.com/vanilla-os/chronos)
documentation server.
## Configuration
The configuration is done in the `public/chronos.json` file. The following
options are available:
```json
{
"title": "Chronos Documentation",
"logoTitle": "Documentation",
"logoUrl": "/logo.svg",
"description": "A frontend in Vue.js for the Chronos documentation server.",
"baseUrl": "http://localhost:5173",
"chronosCollections": [
[
{
"shortName": "docs",
"title": "Docs",
"url": "http://localhost:8080/documentation",
"description": "Read the technical documentation for the Awesome project."
}
],
[
{
"shortName": "handbook",
"title": "Handbook",
"url": "http://localhost:8080/handbook",
"description": "Are you a new user? Read the handbook to learn how to use the Awesome project."
}
]
],
"extraLinks": [
[
{
"url": "https://github.com/vanilla-os/Chronos",
"name": "Source Code"
}
]
]
}
```
the following optional are available for collections:
- `editUrl`: the URL to the edit page of the collection, it must contain the
`{{lang}}` and `{{slug}}` placeholders, for example:
`https://github.com/Vanilla-OS/documentation/blob/main/articles/{{lang}}/{{slug}}.md`
you can also generate the configuration file using the `npm run generate-config`
command, by setting the following environment variables:
- `CHRONOS_TITLE`
- `CHRONOS_LOGO_TITLE`
- `CHRONOS_LOGO_URL`
- `CHRONOS_DESCRIPTION`
- `CHRONOS_BASE_URL`
- `CHRONOS_COLLECTION*` (where \* is a number)
- `CHRONOS_EXTRA_LINK*` (where \* is a number)
for example:
```bash
CHRONOS_TITLE='Chronos Documentation' \
CHRONOS_LOGO_TITLE='Documentation' \
CHRONOS_LOGO_URL='/logo.svg' \
CHRONOS_DESCRIPTION='A frontend in Vue.js for the Chronos documentation server.' \
CHRONOS_BASE_URL='http://localhost:5173' \
CHRONOS_COLLECTION_1='[{"shortName": "docs", "title": "Docs", "url": "http://localhost:8080/documentation", "description": "Read the technical documentation for the Awesome project."}]' \
CHRONOS_COLLECTION_2='[{"shortName": "handbook", "title": "Handbook", "url": "http://localhost:8080/handbook", "description": "Are you a new user? Read the handbook to learn how to use the Awesome project."}]' \
# add more collections here
CHRONOS_EXTRA_LINK_1='[{"url": "https://github.com/vanilla-os/Chronos", "name": "Source Code"}]' \
# add more extra links here
```
## Development
To start the development server, run the following command:
```bash
pnpm dev
```
## Generate Configuration
To generate the configuration file, run the following command:
```bash
pnpm generate-config
```
## Production
To build the production version, run the following command:
```bash
pnpm build
```
### Docker
To deploy the production version using Docker, run the following command:
```bash
docker pull ghcr.io/vanilla-os/chronos-fe:main
docker run -d -p 6090:80 ghcr.io/vanilla-os/chronos-fe:main \
-e CHRONOS_TITLE='Chronos Documentation' \
-e CHRONOS_LOGO_TITLE='Documentation' \
-e CHRONOS_LOGO_URL='/logo.svg' \
-e CHRONOS_DESCRIPTION='A frontend in Vue.js for the Chronos documentation server.' \
-e CHRONOS_BASE_URL='http://localhost:5173' \
-e CHRONOS_COLLECTION_1='[{"shortName": "docs", "title": "Docs", "url": "http://localhost:8080/documentation", "description": "Read the technical documentation for the Awesome project."}]' \
-e CHRONOS_COLLECTION_2='[{"shortName": "handbook", "title": "Handbook", "url": "http://localhost:8080/handbook", "description": "Are you a new user? Read the handbook to learn how to use the Awesome project."}]' \
# add more collections here
-e CHRONOS_EXTRA_LINK_1='[{"url": "https://github.com/vanilla-os/Chronos", "name": "Source Code"}]' \
# add more extra links here
```