flatnotes
Docusaurus
flatnotes | Docusaurus | |
---|---|---|
20 | 282 | |
983 | 52,968 | |
- | 1.3% | |
8.7 | 9.5 | |
8 days ago | 3 days ago | |
Vue | 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.
flatnotes
- Flatnotes: Self-hosted note taking web app that uses Markdown files
-
What self hosted app do you wish existed?
https://github.com/dullage/flatnotes , I find it handy
-
🚀 Happy Star Wars Day! flatnotes 3.0 is now available and now includes a new dark side 🎉
I'm not opposed to this idea but there's a bit of a stumbling block to get past. See the related issue on GitHub for more details (and give it a thumbs up so I can gauge interest).
-
What's a software you searched to selfhost but is still missing to you ?
Try flatnotes for the markdown editor. Simple but functional design, and works smoothly for me
- Looking for the best self-hosted Markdown notes setup with web acces
-
Self-Hosted Markdown Editor (Docker)
Also note that v2 (with a tagging feature) is coming very soon. You can see the release notes for the release candidate here.
-
flatnotes - A note taking web app that uses a flat folder of markdown files for storage
Not as yet but I do like the idea. There's an existing suggestion issue along this line.
-
Looking for a simple wiki (web, not desktop) that stores backend as markdown files?
bash git clone https://github.com/Dullage/flatnotes.git cd flatnotes docker build -t dullage/flatnotes:latest . docker run --rm \ -e "FLATNOTES_USERNAME=user" \ -e "FLATNOTES_PASSWORD=changeMe!" \ -e "FLATNOTES_SECRET_KEY=aLongRandomSeriesOfCharacters" \ -p "80:80" \ dullage/flatnotes:latest Note: As no Docker volumes are mapped in the run command, notes will not be saved when the container is stopped.
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?
ryot - Roll your own tracker!
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
note - {not done/implemented} web and shell cli note taking. hat supports per date note, taging note
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
WikiDocs - 📗 Just a databaseless markdown flat-file wiki engine
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
Gollum - A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
JSDoc - An API documentation generator for JavaScript.
notable - The Markdown-based note-taking app that doesn't suck.
VuePress - 📝 Minimalistic Vue-powered static site generator
Gitit - A wiki using HAppS, pandoc, and git
MkDocs - Project documentation with Markdown.