{"id":13552177,"url":"https://github.com/aerohub/hugo-simpledoc-theme","last_synced_at":"2025-04-30T18:33:14.592Z","repository":{"id":217089917,"uuid":"114148428","full_name":"aerohub/hugo-simpledoc-theme","owner":"aerohub","description":"Hugo Simpledoc Theme is a simple and clean documentation theme for Hugo.","archived":false,"fork":false,"pushed_at":"2018-01-31T07:19:15.000Z","size":614,"stargazers_count":9,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-03T23:34:16.349Z","etag":null,"topics":["documentation","documentation-theme","hugo","hugo-theme"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aerohub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-12-13T17:15:31.000Z","updated_at":"2024-02-07T09:29:20.000Z","dependencies_parsed_at":"2024-01-14T14:36:19.423Z","dependency_job_id":null,"html_url":"https://github.com/aerohub/hugo-simpledoc-theme","commit_stats":null,"previous_names":["aerohub/hugo-simpledoc-theme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerohub%2Fhugo-simpledoc-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerohub%2Fhugo-simpledoc-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerohub%2Fhugo-simpledoc-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerohub%2Fhugo-simpledoc-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aerohub","download_url":"https://codeload.github.com/aerohub/hugo-simpledoc-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224219459,"owners_count":17275477,"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-theme","hugo","hugo-theme"],"created_at":"2024-08-01T12:02:00.169Z","updated_at":"2024-11-12T05:13:02.810Z","avatar_url":"https://github.com/aerohub.png","language":"HTML","funding_links":[],"categories":["HTML","documentation"],"sub_categories":[],"readme":"# hugo-simpledoc-theme\n\nHugo Simpledoc Theme is a simple and clean documentation theme for Hugo. Also you may use it for building a FAQ-page or generating an online book (why not?). This theme is a very-slightly-modified Hugo port of great [WPThemeDoc](https://github.com/richtabor/WPThemeDoc). \n\n## Screenshot\n\n![hugo-simpledoc-theme screenshot](https://github.com/aerohub/hugo-simpledoc-theme/blob/master/images/screenshot.png)\n\n## Features\n\n### Original\n\n- Clean design\n- One page\n- Responsive\n- Easely customizable\n\n### Added\n\n- Hugo!\n\n## Installation\n\n- [Install Hugo](//gohugo.io/overview/installing/) and create a new site.\n- Install hugo simpledoc theme. Inside your new Hugo project run:\n\n```\n$ cd themes\n$ git clone https://github.com/aerohub/hugo-simpledoc-theme\n```\n\n# Writing documentations\n\nThen take a look inside the [`exampleSite`](//github.com/aerohub/hugo-simpledoc-theme/tree/master/exampleSite) folder of this theme. You'll find a file called `config.toml` and a folder `archetypes`. Copy them into the root folder of your Hugo site.\n\n## Configuration\n\nOpen just-copied `config.toml` and fill it with your data. Pay attention for top menu items.\n\nNow you are ready to create your documentation\n\nOK, all you need is just write!\n\nRun in the root of your project:\n\n```\nhugo new my-first-doc-item.md\n```\n\nThen open the file with your favorite text editor and you will see something like this:\n\n```\n---\ntitle: \"My First Doc Item\"\ndate: 2017-12-12T00:57:40+03:00\nanchor: \"my-first-doc-item\"\nweight: \n---\n```\n\nWrite your doc chapter and give it a weight. You may organize your content as you like (even with folders) but **All the docs are ranged by weight here!** Well, the structure of your docs may look like this:\n\n```\ncontent\n├── credits-thanks-and-license.md\n├── getting-started.md\n├── hugo-simpledoc-theme.md\n├── license.md\n├── serving-and-building.md\n└── writing-documentation.md\n```\n\nbut they are ordered by weight you set in frontmatter.\n\n# Serving and building\n\n## Test your site\n\nIn order to see your site in action, run Hugo's built-in local server. \n\n    $ hugo server -w\n\nNow enter `localhost:1313` in the address bar of your browser.\n\n## Build your site\n\nJust run\n\n\t$ hugo\n\nYou'll find your documentation files in `public` folder in the root of Hugo project.\n\n# Credits and Thanks\n\nMany thanks go to:\n\n- [spf13](https://github.com/) \u0026 [Hugo](https://github.com/gohugoio/hugo)\n- [Rich Tabor](https://github.com/richtabor) \u0026 original [WPThemeDoc](https://github.com/richtabor/WPThemeDoc)\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 Pavel Kanyshev\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerohub%2Fhugo-simpledoc-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faerohub%2Fhugo-simpledoc-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerohub%2Fhugo-simpledoc-theme/lists"}