{"id":22294998,"url":"https://github.com/buscedv/docual","last_synced_at":"2025-10-27T10:38:06.232Z","repository":{"id":38228643,"uuid":"208113312","full_name":"Buscedv/Docual","owner":"Buscedv","description":"A self-hosted static frontend for markdown files (ex. GitHub READMEs).","archived":false,"fork":false,"pushed_at":"2023-01-06T03:38:58.000Z","size":7679,"stargazers_count":1,"open_issues_count":24,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T19:42:27.141Z","etag":null,"topics":["documentation","documentation-generator","documentation-tool","free-software","gplv3","open-source","self-hosted","static"],"latest_commit_sha":null,"homepage":"https://docual.edvard.dev","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Buscedv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-12T18:00:56.000Z","updated_at":"2021-01-15T05:56:59.000Z","dependencies_parsed_at":"2023-02-05T05:45:41.976Z","dependency_job_id":null,"html_url":"https://github.com/Buscedv/Docual","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buscedv%2FDocual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buscedv%2FDocual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buscedv%2FDocual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Buscedv%2FDocual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Buscedv","download_url":"https://codeload.github.com/Buscedv/Docual/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245550943,"owners_count":20633944,"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":["documentation","documentation-generator","documentation-tool","free-software","gplv3","open-source","self-hosted","static"],"created_at":"2024-12-03T17:39:59.811Z","updated_at":"2025-10-27T10:38:06.136Z","avatar_url":"https://github.com/Buscedv.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docual\n\n## What is Docual?\nA self hosted frontend for markdown files (ex. GitHub READMEs). Docual picks out your headings and sub-headings, and creates a sidebar for easy navigation. Docual also integrates a powerful search function. \n\nDocual is perfect for documentation and informative content. It takes 5 minutes to setup and updates whenever you update the source markdown file wich can be stored anyware (as long as Docual can access it).\n## Examples\nThe programming language \"Enkelt\" keeps their documentation in a GitHub wiki and uses Docual as a frontend layer.\n[Check it out here](https://dokumentation.enkelt.io)!\n\n# Get Started\n## 1\nClone this repo\nCopy the \"docual\" folder and paste it somewhere else.\n## 2\nConfigure the site from the config files found in the */public* folder (`config.json` and `colors.css`), or change the source of the site. Docual is powered by Vue.js.\n## (2b)\nYou can test your site locally by first running `npm install` and then `npm run serve`, which will start a local server on (default) `http://localhost:8080`.\n## 3\nYou can either host your page on a service like Netlify that offers automatic deploys for Vue.js apps, or you can host it anywere you can hot static webpages by running `npm run build` and then serving your site from the */dist* folder.\n\n# Contact\n\n- [GitHub](https://github.com/Docual)\n- [Email](mailto:me@edvard.io)\n\nEdvard Busck-Nielsen, Docual 2020.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuscedv%2Fdocual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuscedv%2Fdocual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuscedv%2Fdocual/lists"}