{"id":21893676,"url":"https://github.com/asterics/asterics-docs","last_synced_at":"2025-03-22T03:45:02.822Z","repository":{"id":34350178,"uuid":"151413244","full_name":"asterics/asterics-docs","owner":"asterics","description":"Repository to manage AsTeRICS related documentation.","archived":false,"fork":false,"pushed_at":"2025-02-28T13:44:49.000Z","size":427773,"stargazers_count":1,"open_issues_count":8,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-28T19:47:07.691Z","etag":null,"topics":["docs"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asterics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-03T13:00:38.000Z","updated_at":"2025-02-28T13:44:53.000Z","dependencies_parsed_at":"2023-12-17T02:25:11.343Z","dependency_job_id":"2abc4615-1d59-4e9f-ab06-081b0a195c3b","html_url":"https://github.com/asterics/asterics-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asterics","download_url":"https://codeload.github.com/asterics/asterics-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244902918,"owners_count":20529114,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs"],"created_at":"2024-11-28T13:16:00.679Z","updated_at":"2025-03-22T03:45:02.817Z","avatar_url":"https://github.com/asterics.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AsTeRICS Docs\n\nDocumentation of [AsTeRICS](https://github.com/asterics/AsTeRICS.git).\n\n## Configuration\n\n`asterics-docs` is a [VuePress](https://vuepress.vuejs.org/) based project that uses a theme based on the [Default Theme](https://ecosystem.vuejs.press/themes/default/config.html).\nHence, all configuration provided by the *Default Theme* of *VuePress* is available in the custom theme.\n\n::: warning\n\nThe (true) sources of all VuePress configuration files are located at `src/vuepress/`and `src/vuepress/config`.\n\nAfter setting up the project for editing, building and releasing, `asterics-docs` copies all relevant files in the folder `docs/`.\nThe source files for the VuePress configuration are copied to `docs/.vuepress` during this process.\n\n:::\n\n### Sidebar\n\nThe configration for the sidebar is specified in `src/vuepress/config.js` and in the folder `src/vuepress/config/sidebar/`.\n\nIn addition to the [sidebar configuration of the VuePress Default Theme](https://ecosystem.vuejs.press/themes/default/config.html#sidebar), this project contains helper function to assist or automate this process:\n\n* `loadSingleSidebar`: Loads markdown files from a single directory (excluding subdirectories)\n* `loadSidebarFrom`: Creates multi-level navigation for directories with nested content\n* `loadSidebarFromWithPath`: Creates a flat list of links from a single directory\n\nFor better understanding, compare their usage within the existing configuration.\n\n## GitHub Workflows\n\nThis repository provides following workflows:\n\n* [Release](https://github.com/asterics/asterics-docs/actions/workflows/release.yml): builds and deploys website to https://www.asterics.eu/\n* [Prerelease](https://github.com/asterics/asterics-docs/actions/workflows/prerelease.yml): builds and deploys website to https://www.asterics.eu/next/\n* [Algolia](https://github.com/asterics/asterics-docs/actions/workflows/algolia.yml): deletes previous, creates and uploads new index to Algolia\n\nNOTE: Workflow `Release` runs `Algolia` after building the website automatically.\nDon't run workflow `Algolia` after running `Prerelease` since it won't have any effect.\nWhen running workflow `Algolia` manually, enable deletion of the previous index to avoid execeeding the allowed amount of index records.\n\n## Algolia\n\nTo update the search index of Algolia manually, run following command:\n\n```bash\ndocker run -it --env-file=.env -e \"CONFIG=$(cat ./src/vuepress/config/algolia.json | jq -r tostring)\" algolia/docsearch-scraper\n```\n\nTo run this command, you need following tools installed: `docker`, `jq`.\nAdditionally, create a file `.env` and specify following variables:\n\n```bash\nAPPLICATION_ID=\u003cAPP_ID\u003e\nAPI_KEY=\u003cAPI_KEY\u003e\n```\n\n\n## Dependencies\n\n::: warning\nMake sure you use [Node.js v14](https://nodejs.org/download/release/v14.21.3/) before for this setup.\n:::\n\nInstall needed dependencies with\n\n```bash\nyarn install\n```\n\nor (better)\n\n```bash\npnpm install\n```\n\n## Release Instructions\n\n`TODO`: Write instructions\n\n## Usage Instructions\n\nSetup `asterics-docs` using the provided `docs` tools (cf. [DOCS Reference](#DOCS-Reference))\n\n```bash\n# Initialize asterics-docs\n$ yarn docs init\n$ pnpm run docs init\n\n# Deinitialize asterics-docs\n$ yarn docs deinit\n$ pnpm run docs deinit\n\n# Setup docs folder\n$ yarn docs setup\n$ pnpm run docs setup\n```\n\nChange and edit files\n\n```bash\n# Show status\n$ yarn docs status\n$ pnpm run docs status\n```\n\nUpdate changes\n\n```bash\n# Add files for commit\n$ yarn docs add \u003cfile|folder\u003e [\u003cfile|folder\u003e ...]\n$ pnpm run docs add \u003cfile|folder\u003e [\u003cfile|folder\u003e ...]\n\n# Commit files\n$ yarn docs commit\n$ pnpm run docs commit\n\n# Push changes to origin\n$ yarn docs push\n$ pnpm run docs push\n```\n\n`NOTE`:\nYou can inspect and add files without the `docs` tool using `git` in folder setup by the tool.\n\n## Configuration Reference\n\nUse variables in file `.env` to configure the builds\n\n```bash\n# Deployment\n## Host IP address\nHOST=\"127.0.0.1\"\n\n## Host port number\nPORT=8000\n\n## Path to documentation on server\nENDPOINT=\"docs\"\n\n# docs tool\nAUTHOR=\"Max Mustermann \u003cm.mustermann@github.com\u003e\"\nCOMMITTER=\"Madeleine Musterfrau \u003cm.musterfrau@github.com\u003e\"\n```\n\n## DOCS Reference\n\nStart `docs` tool using `yarn`:\n\n```bash\nyarn docs \u003ccommand\u003e\n```\n\nFor detailed instructions use:\n\n```bash\nyarn docs \u003ccommand\u003e --help\n```\n\n### DOCS Commands\n\n```bash\n\n# Main\nyarn docs init\nyarn docs setup\nyarn docs add\nyarn docs commit\nyarn docs push\n\n# Supplementary\nyarn docs status\nyarn docs index\nyarn docs convert\n```\n### TODO\n\n* `yarn docs index`: user selected entries\n* `yarn docs pull`: basic functionality\n* `yarn docs push`: credential handling\n* `yarn docs build/devel`: required?\n* `config.js`: VERSION mappings","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasterics%2Fasterics-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasterics%2Fasterics-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasterics%2Fasterics-docs/lists"}