{"repo":"100mslive/100ms-docs","free":true,"listed":false,"github":"https://github.com/100mslive/100ms-docs","clone":"git clone https://github.com/100mslive/100ms-docs.git","description":"🔥 Blazing fast 100ms Documentation built with nextjs, preact , mdx , next-mdx-remote","language":"TypeScript","stars":82,"topics":["nextjs","mdx","documentation","hacktoberfest"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"If you're here to contribute do check out our Contributing Guidelines & our Code of Conduct 🚀 Getting Started 🔥 Blazing Fast 100ms Docs To run locally - git clone https://github.com/100mslive/100ms-docs.git - yarn or npm install - yarn dev or npm run dev All docs are written in MDX . This allows usage of React components along with the flavor of Markdown Syntax. All docs reside in the /docs folder. 📒 Adding Docs 1. To an existing Doc Suppose you want to add a new section VUE SDK in /v2 docs: - Create a Folder inside /v2/vue-sdk - Folder name would be capitalised and \"-\" would be replaced with space for the section header To add docs in the section: - Create .mdx files in v2/vue-sdk/file-name.mdx - Avoid decimal numbers (For example v-1.3.2.mdx ) in filename (doesn't cause any loss) - Avoid adding ampersand / & in filenames as it breaks Sitemaps generation - It's important to add FrontMatter to the MDX File on top FrontMatter Every .mdx file would need this By default Nav is given the value of Infinity it's important to add nav value to order the Sidebar. But suppose you want to update the order of a doc , then you don't need to change the nav values for all of them. Simply make the nav value in between the preceding and next doc. It can be a decimal value too. 2. To a new Docs (for v3 and soo on) Suppose we now need a v3 docs - Create a folder /docs/v3 - Create a file in /pages/v3/index.tsx in the file add the following This is needed because we need it to route somewhere ","default_branch":null,"files":null,"tree":[],"storefront":"/r/100mslive","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/100mslive/100ms-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}