{"id":13592411,"url":"https://github.com/colinwilson/lotusdocs","last_synced_at":"2025-05-15T16:07:40.589Z","repository":{"id":64886334,"uuid":"556089040","full_name":"colinwilson/lotusdocs","owner":"colinwilson","description":"📖 A free, lightweight, modern documentation theme for Hugo","archived":false,"fork":false,"pushed_at":"2025-02-04T11:14:20.000Z","size":18796,"stargazers_count":459,"open_issues_count":20,"forks_count":104,"subscribers_count":8,"default_branch":"release","last_synced_at":"2025-04-08T00:34:30.977Z","etag":null,"topics":["bootstrap5","documentation","documentation-generator","documentation-theme","hugo","hugo-docs-theme","hugo-documentation","hugo-site","hugo-theme","jamstack","lotus-docs","responsive","vercel"],"latest_commit_sha":null,"homepage":"https://lotusdocs.dev/docs/","language":"JavaScript","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/colinwilson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["colinwilson"],"patreon":null,"open_collective":null,"ko_fi":"colinwilson","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-10-23T03:00:45.000Z","updated_at":"2025-04-07T22:23:14.000Z","dependencies_parsed_at":"2023-09-28T10:09:38.236Z","dependency_job_id":"cef272eb-dee4-4581-992d-24e293563560","html_url":"https://github.com/colinwilson/lotusdocs","commit_stats":{"total_commits":400,"total_committers":5,"mean_commits":80.0,"dds":"0.012499999999999956","last_synced_commit":"f5785a2399ca09e7fb4e7e3d69b397f85df42a24"},"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinwilson%2Flotusdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinwilson%2Flotusdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinwilson%2Flotusdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinwilson%2Flotusdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/colinwilson","download_url":"https://codeload.github.com/colinwilson/lotusdocs/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374475,"owners_count":22060611,"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":["bootstrap5","documentation","documentation-generator","documentation-theme","hugo","hugo-docs-theme","hugo-documentation","hugo-site","hugo-theme","jamstack","lotus-docs","responsive","vercel"],"created_at":"2024-08-01T16:01:08.979Z","updated_at":"2025-05-15T16:07:35.580Z","avatar_url":"https://github.com/colinwilson.png","language":"JavaScript","readme":"# Lotus Docs\n\n[Lotus Docs](https://lotusdocs.dev) is an easily updated and customisable [Hugo](https://gohugo.io/) theme for building fast, secure, and SEO-friendly documentation sites.\n\n![Lotus Docs Banner](https://res.cloudinary.com/lotuslabs/image/upload/r_10/v1693340386/Lotus%20Docs/Social%20Media/lotus_docs_social_preview_github_1280x640_colour_v1.3_xzm1ex.webp)\n\nCheck out the demo site [https://lotusdocs.dev/docs/](https://lotusdocs.dev/docs/) (also doubles as the documentation guide for Lotus Docs 📖)\n\n## Features\n\n* [x] Modern documentation layout\n* [x] Responsive design / Mobile support\n* [x] Fast, Accessible and SEO-Friendly (4 x 💯 scores on [Google Lighthouse](https://pagespeed.web.dev/)!)\n* [x] Secure by default\n* [x] Built on Bootstrap 5\n* [x] Deploy on [GitHub Pages](https://lotusdocs.dev/docs/deployment/platforms/github-pages/), [GitLab Pages](https://lotusdocs.dev/docs/deployment/platforms/gitlab-pages/), [Vercel](https://vercel.com/), [Netlify](https://netlify.com), or [Cloudflare Pages](https://pages.cloudflare.com/)\n* [x] Multilingual support (i18n)\n* [x] Powerful Syntax Highlighting via [Prism.js](https://prismjs.com/)\n* [x] Dark Mode\n* [x] Custom fonts (via [Google Fonts](https://fonts.google.com/))\n* [x] Custom icons (via [Google Material Symbols](https://fonts.google.com/icons?icon.style=Outlined\u0026icon.set=Material+Symbols))\n* [x] Landing page template included\n* [x] Documentation sidebar menu (with optional icons)\n* [x] Table of Contents menu on each page (optional)\n* [x] Customisable theme accent colour\n* [x] Social media links (Github, Twitter, Instagram etc)\n* [x] Static Search plugin option (powered by [FlexSearch](https://github.com/nextapps-de/flexsearch), enabled by default)\n* [x] Support for [DocSearch](https://docsearch.algolia.com/)\n* [x] Custom shortcodes (PrismJS, Alerts, Tabs, Tables)\n* [x] Analytics ([Google Analytics v4](https://analytics.google.com/analytics/web/), [Plausible Analytics](https://plausible.io/))\n* [x] Cross-browser testing via [BrowserStack](https://browserstack.com)\n* [x] Feedback widget\n* [x] Math equations powered by [KaTeX](https://katex.org/)\n* [x] [Mermaid](https://mermaid.js.org/) Support\n* [x] [Open Graph](https://ogp.me/)\n\n\n## Getting Started\n\n### Requirements\n\n- Hugo **Extended** (minimum version: 0.140.0)\n- git\n- Go (minimum version v1.21)\n\n### Initialize your site as a Hugo Module\n\nThe Lotus Docs theme makes use of the [Hugo Bootstrap Module](https://github.com/gohugoio/hugo-mod-bootstrap-scss). For this reason, it's necessary to initialize your site as a Hugo Module. If your site isn't already, use the `hugo mod init` command to initialize your site as a Hugo module:\n\n```bash\nhugo mod init github.com/\u003cusername\u003e/\u003cyour-hugo-site-name\u003e\n```\n\n### Install Options\n\nThe Lotus Docs theme can be installed using one of the following methods:\n\n- As a Hugo Module[^1] (recommended)\n- As a Git submodule\n- Clone the theme files locally\n\nPrerequisites:\n- `contentDir` present in project folder\n\n### Install as a Hugo Module (recommended)\n\nEdit the `hugo.toml` configuration file to include the [Lotus Docs theme](https://github.com/colinwilson/lotusdocs) and the [Hugo Bootstrap module](https://github.com/gohugoio/hugo-mod-bootstrap-scss) as modules:\n\n```toml\nbaseURL = 'http://example.org/'\nlanguageCode = 'en-us'\ntitle = 'My New Hugo Site'\ncontentDir = 'content'\nenableEmoji = true\n\n[module]\n    [[module.imports]]\n        path = \"github.com/colinwilson/lotusdocs\"\n        disable = false\n    [[module.imports]]\n        path = \"github.com/gohugoio/hugo-mod-bootstrap-scss/v5\"\n        disable = false\n\n[markup]\n    [markup.tableOfContents]\n      endLevel = 3\n      startLevel = 1\n  [markup.goldmark]\n    [markup.goldmark.renderer]\n      unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/\n  [markup.goldmark.parser]\n    [markup.goldmark.parser.attribute]\n      block = true\n```\n\n### Install as a Git Submodule\n\nFrom the root of your project run the following `git` commands:\n\n```bash\ngit init\ngit submodule add https://github.com/colinwilson/lotusdocs themes/lotusdocs\n```\n\nEdit the `hugo.toml` config file:\n\n```toml\nbaseURL = 'http://example.org/'\nlanguageCode = 'en-us'\ntitle = 'My New Hugo Site'\ncontentDir = 'content'\nenableEmoji = true\n\n[module]\n    # uncomment line below for temporary local development of module\n    # or when using a 'theme' as a git submodule\n    replacements = \"github.com/colinwilson/lotusdocs -\u003e lotusdocs\"\n    [[module.imports]]\n        path = \"github.com/colinwilson/lotusdocs\"\n        disable = false\n    [[module.imports]]\n        path = \"github.com/gohugoio/hugo-mod-bootstrap-scss/v5\"\n        disable = false\n\n[markup]\n    [markup.tableOfContents]\n      endLevel = 3\n      startLevel = 1\n  [markup.goldmark]\n    [markup.goldmark.renderer]\n      unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/\n  [markup.goldmark.parser]\n    [markup.goldmark.parser.attribute]\n      block = true\n```\n\n### Install Locally\n\nThere may be cases where you prefer to customize and maintain the Lotus Docs theme yourself. In such cases, use `git` to clone the theme into the `themes/lotusdocs` directory:\n\n```bash\ngit clone https://github.com/colinwilson/lotusdocs themes/lotusdocs\n```\n\nEdit the `hugo.toml` config file:\n\n```toml\nbaseURL = 'http://example.org/'\nlanguageCode = 'en-us'\ntitle = 'My New Hugo Site'\n\n[module]\n    # uncomment line below for temporary local development of module,\n    # when using a 'theme' as a git submodule or git cloned files\n    replacements = \"github.com/colinwilson/lotusdocs -\u003e lotusdocs\"\n    [[module.imports]]\n        path = \"github.com/colinwilson/lotusdocs\"\n        disable = false\n    [[module.imports]]\n        path = \"github.com/gohugoio/hugo-mod-bootstrap-scss/v5\"\n        disable = false\n```\n\n## Create New Content\n\nNavigate to the root of your Hugo project and use the `hugo new` command to create a file in the `content/docs` directory:\n\n```shell\nhugo new docs/example-page.md\n```\n\nThis will create a markdown file named `example-page.md` with the following default front matter:\n\n```yaml\n---\ntitle: \"Example Page\"\ndescription: \"\"\nicon: \"article\"\ndate: \"2023-05-22T00:27:57+01:00\"\nlastmod: \"2023-05-22T00:27:57+01:00\"\ndraft: false\ntoc: true\nweight: 999\n---\n```\n\nModify the above front matter options to suit your needs.\n\n## Preview your site locally\n\nNow that you've created some sample content you can preview your new Lotus Docs site using the `huge server` command:\n\n```shell\nhugo server -D\n```\n\nNavigate to `localhost:1313/docs/` and you should see a card link to the **Example Page** created earlier:\n\n![New Lotus Docs Site - Example Content](https://res.cloudinary.com/lotuslabs/image/upload/v1690992310/Lotus%20Docs/images/lotus_docs_new_site_and_content_module_setup_oiuyex.png)\n\n## Author\n\n[Colin Wilson](https://github.com/colinwilson)\n\nCopyright © 2022-2025 [Colin Wilson](https://github.com/colinwilson)\n\n[^1]: [Hugo Modules](https://gohugo.io/hugo-modules/)\n","funding_links":["https://github.com/sponsors/colinwilson","https://ko-fi.com/colinwilson"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolinwilson%2Flotusdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcolinwilson%2Flotusdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolinwilson%2Flotusdocs/lists"}