bookshop
docsy
Our great sponsors
bookshop | docsy | |
---|---|---|
20 | 7 | |
229 | 2,453 | |
2.2% | 2.0% | |
7.7 | 9.2 | |
7 days ago | 12 days ago | |
JavaScript | HTML | |
MIT License | Apache License 2.0 |
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.
bookshop
-
Storybook 8
It seems like CloudCannon has this with their open-source Bookshop component editor which can integrate with their hosted CMS.
https://github.com/CloudCannon/bookshop
The small user base, however, means there probably aren't other CMSs that use the same component representations or CMS live data bindings. This means while Bookshop components are portable between CMSs on paper, it's not in practice (e.g. you can't easily hook it up to another CMS with a visual editor like Wordpress's Gutenberg, Storyblok, etc.).
-
How to import Hugo theme to CloudCannon?
You can use a script to import your Hugo theme but this will only give you text editing functionality (markdown). For the visual editing experience you will need to convert your current theme to a cloudcannon theme using bookshop https://github.com/CloudCannon/bookshop
-
JS Uglify/Minify Gems?
What's everybody using to make their javascript smaller nowadays? I used Grunt to minify my JS, CSS, and images many moons ago but I want to update my template to actually use bundle to deliver my assets since I'm creating a visual editor with CloudCannon.
-
The Top Five Static Site Generators (SSGs) for 2023 — and when to use them!
Bookshop is a component development workflow for static websites. Bookshop defines a convention for building self-contained components in the templating languages supported by common SSGs. Using these conventions, Bookshop provides developer tooling that empowers you to integrate these components with your stack, build and browse UI components locally, and provide rich live editing experiences for your editors.
-
23 of the best Eleventy Themes (Starters) for 2023
Sendit is a multipurpose Eleventy theme made with the Bootstrap CSS framework. The components have been converted to Bookshop. It’s the perfect starting point to see how CloudCannon works.
-
11 Top Eleventy Blog Themes (Starters) in 2023
Sendit is a multipurpose Eleventy theme with a built-in blog, made with the Bootstrap CSS framework. The components have been converted to Bookshop. It’s the perfect starting point to see how CloudCannon’s Visual Editing and component-based page-building works, and how they can really speed up your blogging flow.
-
A new Eleventy theme — in a CMS with full Eleventy support!
For users of our open-source component development workflow Bookshop, we’ve created a full reference guide for Bookshop on Eleventy and a Bookshop starter template. (The Sendit theme comes with Bookshop and a wide range of components already configured, too!)
-
Save Time Building Static Sites: New Editor Improvements
The last place our improvements touch on is visual page building. You can now create new pages in the Visual Editor and edit the page’s default data right away — with no build needed. We also added an option to preview your new page without a build. To get a preview, you’ll need pages configured to render from your front matter using Data Bindings and Previews (we also recommend Bookshop here). Then you can use the new option new_preview_url to set your preview to another page’s output URL. The Visual Editor will load that set preview URL and use the Data Bindings and Previews to render your new page without saving. You can try this with our Megakit template.
-
Introducing Pagefind: Static Low-bandwidth Search at Scale
Our SSGs through the ages series delves into the history of this space, and one of the trends that we’re seeing is larger and larger projects migrating to static websites, helped in part by the efficiency of static site generators like Hugo. We build many such sites for ourselves — the CloudCannon documentation is nothing to sneeze at — as well as for our Enterprise partners, and our customers build yet more on our platform every day. As this scale continues to increase, we find ourselves encountering new and interesting challenges. In the past we have released open-source tools for component-driven development, internationalization, pagination and portability. Now, we have our sights set on search.
-
Why the web is turning away from WordPress
Bookshop, one of our own open-source tools, allows the kind of component-based editing in SSGs such as Hugo, Jekyll, and Eleventy that — to put it bluntly — no one thought was possible. It’s an inflection point that will affect how these SSGs will be used in the coming years; think Elementor’s block-based builder for WordPress, with increasing support for additional platforms that don’t have rigid security and maintenance constraints. With Bookshop, developers can work with custom components on the SSG they choose, without being locked into a single platform.
docsy
-
Apply Docsy
> cd (The root directory of the Git project. themes exists in current) > git submodule add https://github.com/google/docsy.git themes/docsy
-
”Docsy” is a formal theme for technical documentation
Site URL Hugo theme introduction https://themes.gohugo.io/themes/docsy/ Sample/Demo https://example.docsy.dev/ Documentation https://www.docsy.dev/ Repository https://github.com/google/docsy
-
Fifty of 2022's most popular Hugo themes
A set of Hugo documentation templates for launching open source content. Use case(s): Documentation Author: The Docsy Authors Minimum Hugo version: 0.73.0 Github stars: 1706 Last updated: 2022-05-14 License: Apache-2.0
-
Twelve Amazing Free Hugo Documentation Themes
Download Docsy Docsy demo site Minimum Hugo version: 0.73 GitHub stars: 1.7k License: Apache-2.0
-
Ask HN: What are you using for public documentation these days?
Background: I've been a technical writer for 9 years. 6 at Google, 3 as the only writer at an IoT startup.
I helped Corrily with their docs [1] in August. They were interested in readme.io. I wasn't keen on it because I had worked with Retool a few years back and had found readme.io lacking. But I was pleasantly surprised by how much readme.io has progressed since then! If you're looking for a documentation product that is very easy to update and mostly just works, then it's worth checking out.
On https://web.dev I was introduced to Eleventy. Eleventy [2] is now my go to. The documentation for Elecenty itself is very strangely organized and needs a refactor. But I have found that there is always a way to accomplish whatever I need, and usually elegantly.
Another project worth checking out is Docsy [3]. This is a Jekyll template specifically created for technical documentation.
Back at the IoT startup I had to set up the whole documentation system / tooling myself. I used Sphinx and deployed to Heroku. Haven't used Sphinx since then but I remember being satisfied with it back then.
[1] https://docs.corrily.com
[2] https://11ty.dev
[3] https://docsy.dev
-
Need help
I haven't used either of these, but I've heard good things about both https://github.com/google/docsy and https://thegooddocsproject.dev/. If you choose to use either of these, I'd love to hear about it. I have coworkers who contribute to both of them.
What are some alternatives?
flowbite-svelte - Official Svelte components built for Flowbite and Tailwind CSS
Docusaurus - Easy to maintain open source documentation websites.
eleventy-chirpy-blog-template - Blog template for 11ty based on Chirpy UX
MkDocs - Project documentation with Markdown.
elf - Elf is a simple & magical Eleventy starter kit to help you create a project using standard technologies like webpack, Babel and Sass, while also considering ease of use, performance and browser compatibility.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
pagefind - Static low-bandwidth search at scale
hugo-geekdoc - Hugo theme made for documentation
hugo-ink - Crisp, minimal personal website and blog theme for Hugo
hugo-blox-builder - 😍 EASILY BUILD THE WEBSITE YOU WANT - NO CODE, JUST MARKDOWN BLOCKS! 使用块轻松创建任何类型的网站 - 无需代码。 一个应用程序,没有依赖项,没有 JS
hugo-theme-yinyang - A black-white theme for Hugo.
doks - Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.