markdoc
Hugo
markdoc | Hugo | |
---|---|---|
21 | 549 | |
7,006 | 72,657 | |
1.0% | 1.0% | |
5.8 | 9.8 | |
26 days ago | about 4 hours ago | |
TypeScript | Go | |
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.
markdoc
- Markdoc – a flexible Markdown-based authoring framework built by Stripe
-
Ask HN: Stripe like API documentation tool?
Or please share any API documentation tools you use that is opensource and NOT Swagger.
Stripe has Markdoc[0] but it doesn't seem to be automated in any way.
[0]https://markdoc.dev/
- Nota is a language for writing documents, like academic papers and blog posts
-
Looking for a Knowledge-base Tool with SEO Optimization and Multimedia Support for my SaaS - Any Recommendations?
Try using https://markdoc.dev/ .. this is the documentation tool/editor by Stripe and it also powers the extensive documentation of the Stripe product itself .
- Show HN: I’m building open-source headless CMS for technical content
-
I read the full-GitHub-flavored markdown spec so you do not have to. GitHub natively supports many lesser known features including the ability to create diagrams, maps and even 3D models, directly from markdown text.
Extension frameworks like Stripe’s, MarkDoc allows documentation to have code examples in multiple languages.
-
Rust Is the Future of JavaScript Infrastructure
I'm bullish on Rust, but there's a long way still to go. The overhead of passing values across the boundary between JavaScript and Rust is quite high. There are a lot of cases where you want to be able to provide a dynamic configuration to Rust, ideally in JavaScript, and that's still pretty costly from a performance perspective.
One of my projects (https://markdoc.dev/) is a Markdown dialect that supports custom tags and a React renderer. I recently experimented with implementing a parser for it in Rust in order to increase performance. My Rust-based parser is significantly faster than my existing JavaScript parser, but then I have to serialize the AST in order to move it from Rust to JavaScript. I'd like to implement the entire processor in Rust, but I need to let users define custom tags in JavaScript, and the overhead of going back and forth is far from ideal.
I'm hopeful that the recently-ratified Wasm GC proposal—which introduces managed structs and arrays that don't cost anything to pass between the Wasm environment and JavaScript—will help a lot. But it's going to take awhile for Wasm GC features to land in LLVM and be properly supported in Rust.
-
Alternatives to Madcap?
Consider going down the docs-as-code route. There are open source options that require an investment of time for you to become familiar with the tech stack, so learn Markdown and Git if you haven't already. Stripe (who many consider to have some of the best documentation available) created Markdoc as a means of easily maintaining solid docs with some of the fancy quirks of the upper-end doc tools, including content re-use.
-
Use Markdoc and Next.js to Build a Git-powered Markdown Blog
Most modern developer blogs and documentation websites have one thing in common— they run on JAMstack (static websites) and their content is file-based and powered by Git. This allows multiple developers to collaboratively edit content with perks like versioning and version control. In this tutorial, we’re going to see how we can build a simple yet powerful and interactive blog with Next.js and Markdoc.
-
How to create documentation site
Hola. Former Stripe employee here - they use Markdoc: https://markdoc.dev/
Hugo
-
Building static websites
At one point though I realized there is a scaling problem with my build minutes. I knew that golang has considerably faster builds and in my case the easy fix is swapping over to Hugo.
-
Creating excerpts in Astro
This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.
-
Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
Hugo
- Release v0.123.0 · Gohugoio/Hugo
-
Top 5 Open-Source Documentation Development Platforms of 2024
Hugo is a popular static site generator specifically designed to create websites and documentation lightning-fast. Its minimalist approach, emphasis on speed, and ease of use have made it popular among developers, technical writers, and anybody looking to construct high-quality websites without the complexity of typical CMS platforms.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Get People Interested in Contributing to Your Open Project
Create the technical documentation of your project You can use any of the following options: * A wiki, like the ArchWiki that uses MediaWiki * Read the Docs, used by projects like Setuptools. Check Awesome Read the Docs for more examples. * Create a website * Create a blog, like the documentation of Blowfish, a theme for Hugo.
-
Writing a SSG in Go
Doing this made me appreciate existing SSGs like Hugo and Next.js even more👏👏
- Hugo 0.122 supports LaTeX or TeX typesetting syntax directly from Markdown
-
Why Blogging Platforms Suck
I suggest hugo: https://gohugo.io/
Generates a completely static website from MD (and other formats) files; also handles themes (including a lot of them rendering well on mobile), and different types of content - posts, articles, etc. - depending on the theme.
It's open source and, being completely static, cheap as fuck to self host.
What are some alternatives?
mdx - Markdown for the component era
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
MkDocs - Project documentation with Markdown.
vue-markdoc - Vue renderer for Markdoc
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
readme_renderer - Safely render long_description/README files in Warehouse
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
next.js - Markdoc plugin for Next.js
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
vrite - Open-source developer content platform
obsidian-export - Rust library and CLI to export an Obsidian vault to regular Markdown