ag-ssg
Docusaurus
ag-ssg | Docusaurus | |
---|---|---|
10 | 282 | |
1 | 53,091 | |
- | 1.5% | |
10.0 | 9.5 | |
over 1 year ago | 5 days ago | |
JavaScript | 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.
ag-ssg
-
DPS909 Blog :LAB 9 Add Continuous Integration
ag-ssg
-
DPS909 Blog :LAB 8 Automated Testing
One very important part of software development is test automation since it creates an automatic process for one or multiple types of tests to run without the need for manual intervention. Testing helps a large community of developers (or even a single developer) keep a piece of software evolving in the right direction. Without tests, it's easy to break existing code, introduce unexpected bugs, or ignore important edge cases. On my application ag-ssg I have used tools for automating my tests when working on a JavaScript/TypeScript codebase is JEST.
-
DPS909 Blog :LAB 7 Intro to Static Analysis
Link to my project ag-ssg
-
DPS909 Blog :LAB 6 Intro to Docusaurus.
issues-13 issues-14
-
DPS909 Blog :LAB 5 Refactoring
Refactoring of my ssg.
-
Another week, another feature for SSG
Hi, this week I was working on the agg-SSG (https://github.com/anshul137/ag-ssg). It is written with the javascript and was pretty easy to install and use, since it has pretty good documentation.
-
DPS909 Blog :Static Site Generator(ag-ssg) Lab 3
Links to issues created by me in ag-ssg.
-
DPS909 Blog :Static Site Generator (ag-ssg) Release 0.1
Link to repository : ag-ssg.
-
Progress on Release 0.1
minor errors in README.md file - There were some minor spelling, formatting and information errors in the README.md file.
-
DSP 909- Open-Source Lab1
Hey everyone, thanks for reading my Blog post in our first Assignment Release 0.1, we were asked to make the Static Site Generator. I have named it (ag-ssg) you can look at it here, this is my Github repo. In this project we were supposed to create the tool which can convert the .txt file type to .html file type. In this version of our project, User can use the command line tool to specify the particular text file or particular folder which contains multiple text files to convert all of them to .html files. For lab 1 we need to find the partner from our class and collaborate with them using the different platform so that we can review their code and let them review our work as well. The main purpose of this lab is so that we collaborate with our partner and find the problem in our code since all the software will always have problems or bugs. Moreover, with the help of this lab, I was able to grow my network, and it showed me how we actually work in the open-source environment, like by sharing our code, let them help us and increase our debugging problems.
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?
ap21-ssg - repos for DPS909 release 0.1
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
jest - Delightful JavaScript Testing.
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
ESLint - Find and fix problems in your JavaScript code.
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
prettier - Prettier is an opinionated code formatter.
JSDoc - An API documentation generator for JavaScript.
VuePress - 📝 Minimalistic Vue-powered static site generator
MkDocs - Project documentation with Markdown.
mkdocs-material - Documentation that simply works
docsify - 🃏 A magical documentation site generator.