hugo-book
Docusaurus
hugo-book | Docusaurus | |
---|---|---|
13 | 282 | |
2,762 | 52,968 | |
- | 1.3% | |
6.5 | 9.5 | |
6 days ago | 4 days ago | |
HTML | TypeScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
hugo-book
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Releasing 'The Ex-Muslims Quran'
The project is built using Hugo Book, which is an open source static site generator themed with a documentation theme that acts like a book.
-
Need help with my blogdown site formatting issue with blogdown::build_site()
I already have a site created with blogdown and want to make it live. To try it out, I build the site using blogdown::build_site() . After managing to upload all the content from the public folder on Github. I see that the formatting of my site does not match what I have on the localhost when I run blogdown::serve_site(). The site I created is slightly complex since there are many subfolders created under each topic. I used the Hugo Book theme from this github page.
-
Can anyone tell whats wrong with my GitHub Pages deploy?
So I cloned theme to the 'themes' folder. Removed all github related files. Added theme to config file. Hosts well locally with example content.
-
Ask HN: How to maintain a killer product documentation page
We generate a static website using Hugo and a documentation theme. [1] Non-technical members of our team can use Markdown easily and publish changes on their own schedule thanks to a very simple but sturdy CI/CD setup (GitHub Actions and NGINX).
Stripe's documentation is way over-engineered and wasteful IMO, and probably requires a massive to maintain.
[1] https://github.com/alex-shpak/hugo-book)
-
Fifty of 2022's most popular Hugo themes
Download Book theme for Hugo
-
Twelve Amazing Free Hugo Documentation Themes
Download Book Book demo site Minimum Hugo version: 0.43 Extended GitHub stars: 1.8k License: MIT
-
I am struggling to create Hugo book theme.
'hugo new site quickstart cd quickstart git init git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book hugo server --minify --theme hugo-book'
-
How can add R code with output into my Hugo theme?
I am trying to create a tutorial site related to R programming however I can't figure out how to show the output of my code snippet. The theme's documentation does not say much about showing any output and I tried Googling the issue but I could not find anything. I am using the Hugo Book theme and the link can be found [here](https://github.com/alex-shpak/hugo-book). I am using the R blogdown package to create my site with Hugo. If there is any other information, please let me know. Thank you in advance.
-
Hugo mod download cert error
fatal: unable to access 'https://github.com/alex-shpak/hugo-book/': error setting certificate verify locations: CAfile: 'C:\Users\...\ca-bundle.crt' CApath: none Is there some way to fix this?
Docusaurus
-
Alternatives to Docusaurus for product documentation
Docusaurus is a popular open-source documentation tool primarily designed for product documentation and other technical documentation needs. It was first released in 2017 by Facebook Open Source (now Meta Open Source). Just recently, Docsaurus version 3.0 was released.
-
Docusaurus doesn't recognize brackets {} on the markdown files
// @ts-check // `@type` JSDoc annotations allow editor autocompletion and type checking // (when paired with `@ts-check`). // There are various equivalent ways to declare your Docusaurus config. // See: https://docusaurus.io/docs/api/docusaurus-config import { themes as prismThemes } from "prism-react-renderer"; /** @type {import('@docusaurus/types').Config} */ const config = { title: "My Site", tagline: "Dinosaurs are cool", url: "https://your-docusaurus-test-site.com", baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", organizationName: "facebook", // Usually your GitHub org/user name. projectName: "docusaurus", // Usually your repo name. presets: [ [ "docusaurus-preset-openapi", /** @type {import('docusaurus-preset-openapi').Options} */ ({ docs: { sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", }, blog: { showReadingTime: true, // Please change this to your repo. editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", }, theme: { customCss: require.resolve("./src/css/custom.css"), }, }), ], ], themeConfig: /** @type {import('docusaurus-preset-openapi').ThemeConfig} */ ({ navbar: { title: "My Site", logo: { alt: "My Site Logo", src: "img/logo.svg", }, items: [ { type: "doc", docId: "intro", position: "left", label: "Tutorial", }, { to: "/api", label: "API", position: "left" }, { to: "/blog", label: "Blog", position: "left" }, { href: "https://github.com/facebook/docusaurus", label: "GitHub", position: "right", }, ], }, footer: { style: "dark", links: [ { title: "Docs", items: [ { label: "Tutorial", to: "/docs/intro", }, ], }, { title: "Community", items: [ { label: "Stack Overflow", href: "https://stackoverflow.com/questions/tagged/docusaurus", }, { label: "Discord", href: "https://discordapp.com/invite/docusaurus", }, { label: "Twitter", href: "https://twitter.com/docusaurus", }, ], }, { title: "More", items: [ { label: "Blog", to: "/blog", }, { label: "GitHub", href: "https://github.com/facebook/docusaurus", }, ], }, ], copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, }, }), }; export default config;
- Looking for open source documentation generator
-
Show HN: A Python-based static site generator using Jinja templates
Facebook's React/Markdown SSG docusaurus does those things: https://docusaurus.io/
Though you may have to use a plugin for responsive images: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-id...
- Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
-
Top 5 Open-Source Documentation Development Platforms of 2024
Docusaurus is an open-source static site generator built on React and has emerged as a popular tool for developing and maintaining product documentation. Its ease of use, extensive features, and robust community support make it a compelling choice for many organizations.
-
No CMS? Writing Our Blog in React
Wondering why Docusaurus (https://docusaurus.io) did not match their needs. Works perfectly fine as a blogging engine for our tech blog.
-
Best Software Documentation Tools
This is developed by Meta. You can create really nice-looking documentation websites super fast.
-
Can Git or any other VCS be used as a database instead of SQL/NoSQL ones? Have you ever seen such a thing?
Docusaurus, a documentation tool by Facebook, hosts a showcase of other websites that use Docusaurus on their Homepage. The list of websites of this showcase is a typescript files that is maintained by Docusaurus devs, and that you can add your website to through PR: https://github.com/facebook/docusaurus/blob/main/website/src/data/users.tsx
-
Community project: PreventRansomware.io
Fix "Edit this page" links at the bottom of each doc (Problem with the Docusaurus build I guess)
What are some alternatives?
hugo-PaperMod - A fast, clean, responsive Hugo theme.
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
doks - Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
docsy - A set of Hugo doc templates for launching open source content.
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
mdbook-confluence
JSDoc - An API documentation generator for JavaScript.
slate - Beautiful static documentation for your API
VuePress - 📝 Minimalistic Vue-powered static site generator
hugo-shortcodes - Collection of my hugo-shortcodes
MkDocs - Project documentation with Markdown.