{"id":14037164,"url":"https://github.com/thingsym/hugo-theme-techdoc","last_synced_at":"2025-05-16T00:07:18.193Z","repository":{"id":30049371,"uuid":"123775108","full_name":"thingsym/hugo-theme-techdoc","owner":"thingsym","description":"The Techdoc is a Hugo Theme for technical documentation.","archived":false,"fork":false,"pushed_at":"2025-01-30T07:29:18.000Z","size":5250,"stargazers_count":224,"open_issues_count":28,"forks_count":153,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-08T11:11:14.709Z","etag":null,"topics":["hugo","hugo-theme","theme"],"latest_commit_sha":null,"homepage":"https://themes.gohugo.io/hugo-theme-techdoc/","language":"SCSS","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/thingsym.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"thingsym"}},"created_at":"2018-03-04T09:42:33.000Z","updated_at":"2025-03-20T18:27:12.000Z","dependencies_parsed_at":"2024-03-12T09:41:54.739Z","dependency_job_id":"7c937ad5-5a01-4e76-8458-9a458568a4e1","html_url":"https://github.com/thingsym/hugo-theme-techdoc","commit_stats":{"total_commits":219,"total_committers":7,"mean_commits":"31.285714285714285","dds":0.04109589041095896,"last_synced_commit":"56dca591b7b45c9eb81c7c8724515354378a88f3"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingsym%2Fhugo-theme-techdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingsym%2Fhugo-theme-techdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingsym%2Fhugo-theme-techdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingsym%2Fhugo-theme-techdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thingsym","download_url":"https://codeload.github.com/thingsym/hugo-theme-techdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"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":["hugo","hugo-theme","theme"],"created_at":"2024-08-12T03:02:32.746Z","updated_at":"2025-05-16T00:07:13.165Z","avatar_url":"https://github.com/thingsym.png","language":"SCSS","readme":"# Hugo Theme Techdoc\n\nThe Techdoc is a Hugo Theme for technical documentation.\n\n![The Techdoc screenshot](https://raw.githubusercontent.com/thingsym/hugo-theme-techdoc/master/images/screenshot.png)\n\n- Hugo Themes page: [https://themes.gohugo.io/themes/hugo-theme-techdoc/](https://themes.gohugo.io/themes/hugo-theme-techdoc/)\n- Demo site: [https://thingsym.github.io/hugo-theme-techdoc/](https://thingsym.github.io/hugo-theme-techdoc/)\n- Download: [https://github.com/thingsym/hugo-theme-techdoc](https://github.com/thingsym/hugo-theme-techdoc)\n\n## Features\n\n* Modern, Simple layout\n* Responsive web design\n* Documentation menu (Select Menu style)\n* Table Of Contents for the page (selective)\n* Theme color\n* Edit link to documentation repository\n* Header link to HTML headings\n* Custom Shortcodes\n\t* Code highlight with clipboard\n\t* Alert panel\n\t* Button\n* Search Shortcode powered by [Algolia](https://www.algolia.com/)\n* Open Graph\n* Analytics with Google Analytics, Google Tag Manager\n\n## Screenshot\n\n### Theme color\n\n![Theme color](https://raw.githubusercontent.com/thingsym/hugo-theme-techdoc/master/images/screenshot-theme-color.png)\n\n### Menu style\n\n#### Open Menu\n\n![Open Menu](https://raw.githubusercontent.com/thingsym/hugo-theme-techdoc/master/images/screenshot-open-menu.png)\n\n#### Slide Menu\n\n![Slide Menu](https://raw.githubusercontent.com/thingsym/hugo-theme-techdoc/master/images/screenshot-slide-menu.gif)\n\n### Edit link\n\n![Edit link](https://raw.githubusercontent.com/thingsym/hugo-theme-techdoc/master/images/screenshot-edit-link.png)\n\n## Getting Started\n\n### Requirement\n\nHugo minimum version: 0.120.0\n\nDefault Markdown parser library `Goldmark` compatible\n\n### Install Hugo theme on your project as a git submodule\n\nIf you have git installed, you can include hugo-theme-techdoc repository into your core repository as submodule using `git submodule` within your project directory.\n\n```\ncd your_project\ngit submodule add https://github.com/thingsym/hugo-theme-techdoc.git themes/hugo-theme-techdoc\n```\n\nFor more information read [the Hugo documentation](https://gohugo.io/getting-started/quick-start/).\n\n### Or install Hugo theme on your project as a Hugo module\n\nIf you have Go installed, you can add hugo-theme-techdoc to your site as a Hugo module instead of a git submodule. Navigate to your Hugo project root and edit your `hugo.toml`:\n\n```toml\n[module]\n[[module.imports]]\npath = 'github.com/thingsym/hugo-theme-techdoc'\n```\n\nThen, to install/update the hugo-theme-techdoc module, run:\n\n```\nhugo mod get -u\n```\n\n### Or download Hugo theme on your project\n\nIf you have git installed, you can do the following at the command-line-interface within your project directory.\n\n```\ncd your_project/themes\ngit clone https://github.com/thingsym/hugo-theme-techdoc.git\n```\n\n### Configure\n\nYou may specify options in hugo.toml (or hugo.yaml/hugo.json) of your site to make use of this theme's features.\n\nFor an example of `hugo.toml`, [hugo.toml](https://github.com/thingsym/hugo-theme-techdoc/blob/master/exampleSite/hugo.toml) in exampleSite.\n\n### Update Hugo theme for git submodule\n\n```\ngit submodule update --remote\ngit add themes/hugo-theme-techdoc\ngit commit\n```\n\n### Directory layout\n\n```\ntree . -I node_modules\n\n.\n├── LICENSE.md\n├── README.md\n├── archetypes\n│   └── default.md\n├── compose.yml\n├── exampleSite\n│   └── ..\n├── gulpfile.js\n├── images\n│   └── ..\n├── layouts\n│   ├── 404.html\n│   ├── blog\n│   │   ├── li.html\n│   │   ├── list.html\n│   │   ├── single.html\n│   │   └── summary.html\n│   ├── _default\n│   │   ├── baseof.html\n│   │   ├── list.algolia.json\n│   │   ├── list.html\n│   │   └── single.html\n│   ├── index.html\n│   ├── partials\n│   │   ├── content-footer.html\n│   │   ├── custom-css.html\n│   │   ├── custom-head.html\n│   │   ├── edit-meta.html\n│   │   ├── edit-page.html\n│   │   ├── footer.html\n│   │   ├── global-menu.html\n│   │   ├── head.html\n│   │   ├── last-updated.html\n│   │   ├── menu\n│   │   │   ├── open-menu.html\n│   │   │   └── slide-menu.html\n│   │   ├── meta\n│   │   │   ├── chroma.html\n│   │   │   ├── google-analytics-async.html\n│   │   │   ├── google-site-verification.html\n│   │   │   └── tag-manager.html\n│   │   ├── notification.html\n│   │   ├── pagination.html\n│   │   ├── powered.html\n│   │   ├── prepend-body.html\n│   │   ├── search.html\n│   │   ├── sidebar-footer.html\n│   │   ├── sidebar.html\n│   │   ├── site-header.html\n│   │   └── table-of-contents.html\n│   ├── posts\n│   │   ├── list.html\n│   │   └── single.html\n│   ├── shortcodes\n│       ├── button.html\n│       ├── code.html\n│       ├── panel.html\n│       └── search.html\n├── package-lock.json\n├── package.json\n├── resources\n├── src\n│   ├── js\n│   │   ├── code.js\n│   │   ├── headerlink.js\n│   │   ├── jquery.backtothetop\n│   │   │   ├── jquery.backtothetop.js\n│   │   │   └── jquery.backtothetop.min.js\n│   │   ├── keydown-nav.js\n│   │   ├── main.js\n│   │   └── sidebar-menu.js\n│   └── scss\n│       ├── _component.scss\n│       ├── _project.scss\n│       ├── _structure.scss\n│       ├── _variable.scss\n│       ├── chroma.scss\n│       ├── foundation\n│       │   ├── _element.scss\n│       │   ├── _index.scss\n│       │   ├── _normalize.scss\n│       │   ├── _reset.scss\n│       │   └── _stack.scss\n│       ├── function\n│       │   ├── _calc-font-size.scss\n│       │   ├── _calc-stack.scss\n│       │   ├── _contrast-color.scss\n│       │   ├── _index.scss\n│       │   └── _strip-unit.scss\n│       └── theme.scss\n├── static\n│   ├── css\n│   │   ├── chroma.css\n│   │   ├── chroma.min.css\n│   │   ├── theme.css\n│   │   └── theme.min.css\n│   ├── images\n│   └── js\n│       └── bundle.js\n├── theme.toml\n└── webpack.config.js\n```\n\n### Preview site\n\nTo preview your site, run Hugo's built-in local server.\n\n```\nhugo server -t hugo-theme-techdoc\n```\n\nBrowse site on http://localhost:1313\n\n## Deploy Site to public_html directory\n\n```\nhugo -t hugo-theme-techdoc -d public_html\n```\n\n## Local development environment\n\n### Preview exampleSite\n\n```\ncd /path/to/dir/themes/hugo-theme-techdoc/exampleSite\n\nhugo server --themesDir ../..\n```\n\nBrowse site on http://localhost:1313\n\n### Build development\n\n```\ncd /path/to/hugo-theme-techdoc\nnpm install\nnpm run gulp watch\n```\n\n## Docker development environment\n\n### Run Docker and Preview exampleSite\n\n```\ncd /path/to/hugo-theme-techdoc\ndocker compose up -d\n```\n\nBrowse site on http://localhost:1313\n\n### Stop container and remove container\n\n```\ndocker compose down -v\n```\n\n### Build development\n\n```\ncd /path/to/hugo-theme-techdoc\ndocker compose run --rm node npm install\ndocker compose run --rm node npm run watch\n```\n\n## Contribution\n\n### Patches and Bug Fixes\n\nSmall patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.\n\n1. Fork [Hugo Theme Techdoc](https://github.com/thingsym/hugo-theme-techdoc) from GitHub repository\n2. Create a feature branch: git checkout -b my-new-feature\n3. Commit your changes: git commit -am 'Add some feature'\n4. Push to the branch: git push origin my-new-feature\n5. Create new Pull Request\n\n## Changelog\n\n* Version 1.0.2 - 2025.01.30\n\t* bump up version jQuery Plugin Back to the Top\n* Version 1.0.1 - 2024.08.20\n\t* fix README\n\t* fix exampleSite document\n\t* fix sass\n\t* update npm dependencies\n\t* fix hugo config\n\t* rename docker-compose.yml to compose.yml\n\t* change hugo docker image\n\t* fix deprecation warning [#68]\n\t* bring example site up to date [#66]\n\t* fix typos [#65]\n\t* fix github workflows\n* Version 1.0.0 - 2023.08.21\n\t* update hugo docker image\n\t* update npm dependencies\n\t* allow to set branch of github documentation repository [#64]\n\t* enable use as a Hugo module [#63]\n* Version 0.9.9 - 2022.07.08\n\t* fix scss\n\t* bump up version on jquery, jquery.easing and clipboard\n\t* update node package dependencies\n\t* change service name\n\t* change fontawesome delivery from cdn to self-host\n\t* fix config.toml\n\t* id and class elements added to menu items\n\t* pre and post elements added to menu items [#48]\n\t* use SRI for CDN js sources [#45]\n\t* fix heading styles\n\t* change to using math.div for division\n* Version 0.9.8 - 2021.10.18\n\t* fix sample document\n\t* edit README\n\t* update package.json\n\t* add github_doc_repository_path\n\t* change to relative link\n\t* add workflows for publishing demo site to gh-pages\n* Version 0.9.7 - 2021.03.08\n\t* add docker-compose.yml for development environment\n\t* change keyboard event from event.keyCode to event.key because it is deprecated\n\t* update package.json\n\t* add FUNDING.yml\n\t* fix space for minify publish\n\t* change flexbox-grid-mixins from libsass to dart-sass\n* Version 0.9.6 - 2020.11.22\n\t* add sample Markdown Syntax\n\t* update sample document\n\t* replace scss from node-sass to dart-sass\n* Version 0.9.5 - 2020.11.05\n\t* fix link style with Alert panel\n* Version 0.9.4 - 2020.10.08\n\t* improve scss for custom shortcodes using css custom properties\n\t* change stack to css custom properties\n\t* fix scss\n\t* fix button shortcode, adding notice color\n\t* add Code highlight with clipboard custom shortcode\n\t* fix webpack.config.js\n\t* fix npm scripts\n\t* update package.json\n\t* adjust no sidebar layout\n* Version 0.9.3 - 2020.08.02\n\t* remove jQuery dependency with keydown nav\n\t* add header link\n* Version 0.9.2 - 2020.06.14\n\t* add note and sample to document\n\t* fix tableOfContents endLevel\n\t* add chapter 'unlimited levels' to document\n\t* add menu indentation up to 5 levels\n* Version 0.9.1 - 2020.05.24\n\t* fix config.toml\n\t* fix url in rss meta link\n\t* remove line break\tin algolia.json\n* Version 0.9.0 - 2020.04.01\n\t* fix lint config\n\t* update Sample Document\n\t* update jQuery to v3.4.1\n\t* add search function and shortcode powered by Algolia\n\t* fix config.toml\n\t* fix sass\n\t* fix hugo deprecated warning\n* Version 0.8.3 - 2020.03.19\n\t* fix edit page link\n* Version 0.8.2 - 2020.03.07\n\t* fix open graph image path\n* Version 0.8.1 - 2020.03.07\n\t* fix open graph image path\n* Version 0.8.0 - 2020.02.27\n\t* update Sample Document\n\t* config.toml\n\t* add open graph image to exampleSite\n\t* add safeCSS for ZgotmplZ with generated by Hugo Template\n* Version 0.7.0 - 2020.02.07\n\t* bump up Hugo minimum version to 0.60.0\n\t* change shortcode delimiter from % to \u003c\n\t* improve tableOfContents for Goldmark\n* Version 0.6.0 - 2020.01.13\n\t* fix scss\n\t* gulp bump up version to 4.0\n\t* fix hugo deprecated warning\n* Version 0.5.0 - 2019.12.08\n\t* update Sample Document\n\t* add table of contents\n\t* add open graph\n\t* add function and stack scss\n* Version 0.4.0 - 2019.11.02\n\t* update Sample Document\n\t* add Theme color\n\t* add Menu style\n\t* improve scss\n* Version 0.3.0 - 2019.10.06\n\t* fix archetypes\n\t* add prepend-body.html for Tag Manager noscript version\n\t* change class name from menu to global-menu\n\t* rename partials files\n\t* fix javascript path for webpack\n\t* improve development environment\n\t* move javascript files to src directory\n* Version 0.2.2 - 2019.04.27\n\t* fix Lastmod's and PublishDate's initial value of 0001-01-01\n* Version 0.2.1 - 2018.12.07\n\t* fix scss lint errors\n\t* change lint from scss-lint to stylelint\n\t* add published date\n\t* change the font color of powered by\n\t* fix link on powered by\n* Version 0.2.0 - 2018.11.21\n\t* add screenshot images\n\t* add exampleSite\n\t* fix sub-menu for responsive\n\t* improve menu and pagination\n* Version 0.1.0 - 2018.03.04\n\t* initial release\n\n## License\n\nTechdoc is licensed under the MIT License.\n\nTechdoc bundles the following third-party resources:\n\n* CSS reset by [normalize.css](https://necolas.github.io/normalize.css/), [MIT](https://opensource.org/licenses/MIT)\n* jQuery Plugin [Back to the Top](https://github.com/thingsym/jquery.backtothetop), [MIT](https://opensource.org/licenses/MIT)\n* Sass Mixin [Flexbox Grid Mixins](https://thingsym.github.io/flexbox-grid-mixins/), [MIT](https://opensource.org/licenses/MIT)\n* [jQuery](https://jquery.com/)\n* [jQuery Easing](https://github.com/gdsmith/jquery.easing)\n* [Font Awesome](https://fontawesome.com/)\n* [clipboard.js](https://clipboardjs.com/)\n* [algoliasearch](https://github.com/algolia/algoliasearch-client-javascript)\n* [Day.js](https://github.com/iamkun/dayjs)\n\n## Author\n\n[thingsym](https://github.com/thingsym)\n\nCopyright (c) 2017-2020 by [thingsym](https://management.thingslabo.com/)\n","funding_links":["https://github.com/sponsors/thingsym"],"categories":["SCSS"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthingsym%2Fhugo-theme-techdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthingsym%2Fhugo-theme-techdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthingsym%2Fhugo-theme-techdoc/lists"}