Merge pull request #2320 from JuanPabloDiaz/docs

Add Documentation

components/TopBar/CategoryDescriptions.ts

@@ -146,6 +146,8 @@ const categoryDescriptions: CategoryDescriptions = {
     'An ebook (short for electronic book) is a book publication made available in digital form, consisting of text, images, or both readable on the flat-panel display of computers or other electronic devices.',
   hosting:
     'Web hosting is an online service that makes the content of your website accessible on the internet. When you purchase a hosting plan, you are renting space on a physical server to store all the files and data.',
+  docsgenerator:
+    'The term “doc” is short for “documentation”. Here you can find various Technical Documentation generators.',
   dsa: 'Data Structures and Algorithms play an important role in tech placements. So here is a list of important and great dsa resources',
   officialdocs:
     'Official docs is short for official documentation. Official documentation is an important resource for users of software products and services as it provides a comprehensive guide to using the software.',

database/data.ts

@@ -62,7 +62,7 @@ export const sidebarData: ISidebar[] = [
         name: 'js-Chart Libraries',
         url: '/js-chart-libraries',
         resources: DB.jsChartLibraries,
-      }
+      },
     ],
   },
   {
@@ -263,6 +263,11 @@ export const sidebarData: ISidebar[] = [
     category: 'resources',
     subcategory: [
       { name: 'blogs', url: '/blogs', resources: DB.blogs },
+      {
+        name: 'Docs Generator',
+        url: '/docsgenerator',
+        resources: DB.docsgenerator,
+      },
       {
         name: 'Official Docs',
         url: '/officialdocs',

database/index.ts

@@ -16,7 +16,7 @@ export { default as react } from './frontend/react.json'
 export { default as next } from './frontend/next.json'
 export { default as _3dLibraries } from './frontend/3d-libraries.json'
 export { default as uilibraries } from './frontend/ui-libraries.json'
-export { default as jsChartLibraries} from './frontend/js-chart-libraries.json'
+export { default as jsChartLibraries } from './frontend/js-chart-libraries.json'
 // backend
 export { default as authentication } from './backend/authentication.json'
 export { default as architecture } from './backend/architecture.json'
@@ -82,6 +82,7 @@ export { default as openSourceTools } from './open_source/tools.json'
 export { default as openSourceTutorials } from './open_source/tutorials.json'
 // resources
 export { default as blogs } from './resources/blogs.json'
+export { default as docsgenerator } from './resources/docs-generator.json'
 export { default as officialdocs } from './resources/official-docs.json'
 export { default as hosting } from './resources/hosting.json'
 export { default as ebook } from './resources/e-book.json'

database/resources/docs-generator.json

@@ -0,0 +1,66 @@
+[
+  {
+    "name": "DevDocs",
+    "description": "DevDocs combines multiple API documentations in a fast, organized, and searchable interface. Here you can find documentation for many popular programming languages and frameworks.",
+    "url": "https://devdocs.io/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "Docsify",
+    "description": "If you're looking for a static generator that makes it easier for you to create docs, you'll love Docsify. Unlike GitBook, it does not generate static HTML files. Instead, it loads and parses your Markdown files and displays them as a website.",
+    "url": "https://docsify.js.org/#/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "Docusaurus",
+    "description": "If you need a static generator to help you build your product’s documentation site, Docusaurus is your tool! :) Not only does it provide you with fast-side client navigation that takes interactivity to new heights, but also out-of-the-box documentation features that can help make your site stand out from the others.",
+    "url": "https://docusaurus.io/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "GitBook",
+    "description": "GitBook is a modern documentation platform where teams can document everything from products to internal knowledge-bases and APIs. It is a tool for teams and individuals to write and host beautiful documentation.",
+    "url": "https://www.gitbook.com/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+
+  {
+    "name": "jsDoc",
+    "description": "JSDoc is a markup language used to annotate JavaScript source code files. Using comments containing JSDoc, programmers can add documentation describing the application programming interface of the code they're creating.",
+    "url": "https://jsdoc.app/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "MkDocs",
+    "description": "MkDocs is a fast, simple, and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.",
+    "url": "https://www.mkdocs.org/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "Sphinx",
+    "description": "Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages.",
+    "url": "http://www.sphinx-doc.org/en/master/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "Typedoc",
+    "description": "TypeDoc is a documentation generator for TypeScript projects. It generates API documentation in HTML format from comments in your source code.",
+    "url": "https://typedoc.org/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  },
+  {
+    "name": "VuePress",
+    "description": "VuePress is a minimalistic static site generator with a Vue-powered theming system, and a default theme optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub-projects.",
+    "url": "https://vuepress.vuejs.org/",
+    "category": "resources",
+    "subcategory": "docsgenerator"
+  }
+]

database/technical-writing/tools.json

@@ -1,11 +1,4 @@
 [
-  {
-    "name": "Docsify",
-    "description": "If you're looking for a static generator that makes it easier for you to create docs, you'll love Docsify. Unlike GitBook, it does not generate static HTML files. Instead, it loads and parses your Markdown files and displays them as a website.",
-    "url": "https://docsify.js.org/#/",
-    "category": "technical-writing",
-    "subcategory": "technical-writing-tools"
-  },
   {
     "name": "Hugo",
     "description": "If you're looking for a framework to help you build your documentation site quickly, check out Hugo. It allows you to output your content in multiple formats, including JSON or AMP as well as provides shortcodes to simplify your Markdown files.",
@@ -26,12 +19,5 @@
     "url": "https://hemingwayapp.com/",
     "category": "technical-writing",
     "subcategory": "technical-writing-tools"
-  },
-  {
-    "name": "Docusaurus",
-    "description": "If you need a static generator to help you build your product’s documentation site, Docusaurus is your tool! :) Not only does it provide you with fast-side client navigation that takes interactivity to new heights, but also out-of-the-box documentation features that can help make your site stand out from the others.",
-    "url": "https://docusaurus.io/",
-    "category": "technical-writing",
-    "subcategory": "technical-writing-tools"
   }
 ]

public/sitemap.xml

@@ -153,6 +153,11 @@
         <loc>https://www.linkshub.dev/blogs</loc>
         <lastmod>2023-06-28T21:40:52+00:00</lastmod>
         <priority>0.8</priority>
+    </url>
+       <url>
+        <loc>https://www.linkshub.dev/docsgenerator</loc>
+        <lastmod>2023-06-28T21:40:52+00:00</lastmod>
+        <priority>0.8</priority>
     </url>
     <url>
         <loc>https://www.linkshub.dev/e-book</loc>