Description
Does your project have some documentation & wiki to be shared publically?We've seen a poor way of doing it: plain PDF and unformatted chat messages that get outdated quickly and are not exciting. The software usually has a lot of documentation around it. So we suggest learning from the best and mimicking the biggest tech companies, such as Facebook, in their approach to sharing wiki knowledge. Have a quick look at the docs websites in the resource section: Verdaccio, Hasura, and Edulinks. Always available online, they look readable on a device of any size, support a multitude of languages with a click of a button, and offer appropriate information for each of the software's versions (e. g., Hasura has version dropdown `v2. x` at the top). a structured sidebar allows jumping between sections, and the content has many formatting options to draw the reader's attention to important parts. One can even insert Youtube videos, maps, or other embeddable content for a better illustration. And guess what - all of the above websites (and many hundreds of others) use the same open-source (free) software called Docusaurus. Not surprising if you haven't heard about it, as so far, only developers used it for other developers. In this course, we want to show how to make a wiki website using Docusaurus. Its motto is Build optimized websites quickly, focus on your content. Combining this philosophy with some handy tools like CodeSandbox, one needs zero coding knowledge to make his Docusaurus website. By completing the lectures: You'll know how to host and version your content on GithubMake use of CodeSandbox to edit and preview the changes in real-timeUse Vercel to deliver the content as a website with your customized domain nameAdditionally, your website is going to be FREE to make and FREE to host! Contrary to many other website builders like famous WordPress, Docusaurus doesn't need a server. So, unless you have massive traffic, Vercel's generous free tier will cover all expenses. Docusaurus is software with many options, such as website translation, versioning, custom pages, and blogging support. However, this is a beginner course, and we can't dive too deep. Likely, you can figure those features out by simply reading the official docs. If not, you can always ask us a question:)Please be aware that changing the design and making custom landing pages (those that are not part of documentation or blog) do require some basic coding knowledge and are not covered in this course. This being said, the default design is already very beautiful and you will learn in this course how to customize many aspects of your website: colors, menus, docs style, etc. So, what are you waiting for? You can have your website live in less than 30 minutes!
