{"id":31831233,"url":"https://github.com/livingdocsio/documentation","last_synced_at":"2026-05-18T00:14:39.220Z","repository":{"id":14570244,"uuid":"17286296","full_name":"livingdocsIO/documentation","owner":"livingdocsIO","description":"Livingdocs Documentation","archived":false,"fork":false,"pushed_at":"2026-02-02T03:18:45.000Z","size":76387,"stargazers_count":34,"open_issues_count":3,"forks_count":13,"subscribers_count":16,"default_branch":"main","last_synced_at":"2026-02-02T15:10:29.890Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://docs.livingdocs.io","language":"CSS","has_issues":false,"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/livingdocsIO.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-02-28T13:03:39.000Z","updated_at":"2026-02-02T03:17:01.000Z","dependencies_parsed_at":"2024-02-22T11:26:56.330Z","dependency_job_id":"e4098bf0-c6fa-4e65-91e8-5f7286567842","html_url":"https://github.com/livingdocsIO/documentation","commit_stats":null,"previous_names":[],"tags_count":7456,"template":false,"template_full_name":null,"purl":"pkg:github/livingdocsIO/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livingdocsIO","download_url":"https://codeload.github.com/livingdocsIO/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29121681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T10:47:47.471Z","status":"ssl_error","status_checked_at":"2026-02-05T10:45:08.119Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation"],"created_at":"2025-10-11T21:48:26.120Z","updated_at":"2026-02-05T12:02:29.471Z","avatar_url":"https://github.com/livingdocsIO.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Livingdocs Documentation\n\n## Local Setup\n\nThis documentation is built using [Hugo](https://gohugo.io/).\n\nYou can run it locally:\n\n```bash\n# install hugo\nbrew install hugo\n\n# install dependencies\nnpm install\n\n# start the hugo dev server\nnpm start\n```\n\nIf you use WSL2 and want a new browser window to open automatically when running the documentation locally, install `wslu`. You can find installation instructions in the [`wslu` documentation](https://wslutiliti.es/wslu/install.html). For example, on Ubuntu in WSL2, run:\n\n```bash\nsudo apt install wslu\n```\n\nWhen working with the lunr search code it can be useful to test the real production setup, due to the way we edit the search index for production:\n\n```bash\n# build the static site into `./public`\nnpm run build\n# or the uncompressed version\nnpm run build:fast\n\n# serve the `./public` directory\nnpm run start:production\n```\n\nWhen editing code you can run `npm run build:fast` in a separate terminal and then refresh the page to see the latest changes. This only takes 1-2 seconds.\n\n## Contribution Guide\n\n### Titles and Subtitles\n\nAlways start with `h2` titles in your documents (`h1` should only be used by templates for the page title). Then use `h3` for subtitles.\n\nCheck your titles by reading the table of contents generated on the right side of the screen. The titles should make it clear what is to be expected in a section. E.g. avoid generic titles like 'Example'.\n\n### Shortcodes\n\n```markdown\n{{\u003c vimeo id=\"426279221\" class=\"video-wrapper\" \u003e}}\n```\n\n```markdown\n{{\u003c github \"livingdocsIO/livingdocs-cli\" \"Livingdocs command line utility\" \u003e}}\n```\n\n```markdown\n{{\u003c warning \u003e}}The world is not a logic puzzle{{\u003c /warning \u003e}}\n```\n\n```markdown\n{{\u003c added-in \"release-2021-03\" \u003e}}\n```\n\n```markdown\n{{\u003c deprecated-in \"release-2021-03\" \u003e}}\n```\n\n```markdown\n{{\u003c removed-in \"release-2021-03\" \u003e}}\n```\n\n```markdown\n{{\u003c release \"release-2021-03\" \u003e}}\n```\n\n```markdown\n{{\u003c feature-info \"li-documents feature\" \"server\" \u003e}}\n```\n\n_Note: Shortcode templates can be found in `themes/hugo-docs/layouts/shortcodes`._\n\n### Text\n\nAlways be brief and concise. Don't state opinions or use unnecessary adjectives. Or as Einstein puts it «as simple as possible but no simpler».\n\nIn the guides always state what a certain guide is trying to achieve. Be comprehensive, i.e. don't leave out stuff that would frustrate people following your guide.\n\n### Images\n\nImages shouldn't be too high. Try to capture images with a 4/3 or similar ratio.\n\n### Screenshots\n\nIf you need to take a screenshot of a whole browser, either try to capture just the content without frame or just the specific window.\n\nOn a mac, press `CMD+Shift+4` to capture a specific section on the screen.\nIf you press `Shift` once if the screenshot tool is still open, you can capture a whole window.\n\n### Terminal\n\nPlease try to capture a nice segment. If possible try to embed the text in a text code block or use [this website to generate an image](https://carbon.now.sh/?bg=rgba%280%2C0%2C0%2C0%29\u0026t=lucario\u0026wt=bw\u0026l=auto\u0026ds=false\u0026dsyoff=20px\u0026dsblur=68px\u0026wc=false\u0026wa=true\u0026pv=56px\u0026ph=56px\u0026ln=true\u0026fl=1\u0026fm=Fira+Code\u0026fs=14px\u0026lh=152%25\u0026si=false\u0026es=2x\u0026wm=false\u0026code=const%2520cars%2520%253D%2520%255B%27BMW%27%252C%2520%27Volvo%27%252C%2520%27Mini%27%255D%250A%250Afor%2520%28const%2520car%2520of%2520cars%29%2520%257B%250A%2520%2520console.log%28%2560car%253A%2520%2524%257Bcar%257D%2560%29%250A%257D).\n\n## Hugo Theme\n\n### Icons\n\nSome icons were copied individually to `themes/hugo-docs/assets/svg` from\n\u003chttps://primer.style/octicons/\u003e.\n\n## Document Headers\n\nEvery document has a header to control the behavior in the documentation. Below you will see an example:\n\n```\n---\ntitle: Setup Notifications\nlinkTitle: Notifications\ndescription: Configure notifications so users can watch documents\nweight: 6\n---\n```\n\n## Endpoint Versioning\n\n### How to do versioned api changes\n\n### Behavior of versioned endpoints\n\n### How to introduce new endpoints\n\n### How to make changes to version endpoints\n\n### Properties\n\n```yaml\n// a document will not be in search results\nexcludeFromSearch: true\n\n// a document will not be rendered. Start your server with `npm run start -- -D` to see drafts for development\ndraft: true\n\n// don't show the edit button for updating a document at github\nrenderEditButton: false\n\n// don't show document teaser cards\nrenderSummaries: false\n\n// don't show table of contents on the right side of the page\nrenderTOC: false\n\n// helps search engine to find alternative words which is not in the body of the document\nkeywords:\n  - myKeyword\n```\n\n### Teaser Properties\n\nHere you can see an example, how to define a document teaser\n\n```\n---\ntitle: My title\nlinkTitle: This is my card title\nbullets:\n  - item 1 in your bullet list\n  - item 2 in your bullet list\ndescription: Describe the document\nweight: 6\n---\n```\n\n![image](https://user-images.githubusercontent.com/172394/140274827-1fdf9774-8664-44cc-ae62-cb17089461cc.png)\n\n`linkTitle` - a document teaser card takes `title` as default, with `linkTitle`, you can overwrite the teaser title\n\n## Development\n\n### Debug Links in the documentation\n\n```bash\nnpm install -g markdown-link-check\nmarkdown-link-check SUMMARY.md -q\n```\n\n## Release Notes\n\n### Generate Release Changes File\n\nThe script `bin/generate-release-changes.js` allows you to generate a changelog-style file that compiles all Pull Request descriptions included in a given release. It provides a clear and comprehensive overview and supports the creation of release notes.\n\nUsage:\n\n```\nnode bin/generate-release-changes.js [options] \u003cmarkdown-file\u003e\n```\n\nOptions:\n\n```\n  -f, --format \u003cformat\u003e  Output format: json or markdown (default: json)\n  -h, --help            Show help\n```\n\nExample:\n\n```\nnode bin/generate-release-changes.js release-2025-07.md\nnode bin/generate-release-changes.js --format=markdown release-2025-07.md\n```\n\n#### Generate Github Access Token\n\nTo run the script, you must provide a valid `GitHub Access Token` with proper repository access.\n\nSteps to Generate a Token\n\n1. Go to GitHub → Profile → Settings → Developer Settings → Personal Access Tokens\n\n2. Choose Tokens (Classic) and click Generate new token (Fine-grained)\n\n3. Configure the token:  \n   Resource Owner: LivingdocsIO  \n   Repository Access: Only selected repositories  \n   Select: Editor, Server, Documentation\n   Permissions: Pull requests: Read-only \u0026 Contents: Read-only\n\n4. Click Generate Token, wait for permissions to be granted, then copy the token.\n\n5. Set the github token for the generate script\n   ```\n   export GITHUB_TOKEN=\u003ccreated-github-token\u003e\n   ```\n\n#### Generate and view output file\n\nTo generate and open a Markdown file with all included PR descriptions:\n\n```\n// Generate file\nnode bin/generate-release-changes.js --format=markdown content/operations/releases/release-2025-07.md b/content/operations/releases/release-2025-07.md \u003e changes.md\n\n// View the file\nopen changes.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivingdocsio%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivingdocsio%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivingdocsio%2Fdocumentation/lists"}