
A story about how I started teaching about open-source.
This article describes and references resources to understand better the three online services needed to launch your documentation website.
A step-by-step guide on how to signup on github.com
A step-by-step guide on how to signup on vercel.com
This lecture is a step-by step guide to connect Github with Vercel and make your website live!
In this lecture, you will learn how to configure your website to appear under a domain name you own.
If you are unfamiliar with the concept, please read the article in the resources section.
In this video, you will sign up on CodeSandbox and get a quick overview of how this service works.
In this lesson, we'll cover the full cycle of updating Docusaurus so that your visitors see the latest version. It involves:
Making changes in CodeSandbox
Opening A PR (pull request) in Github
Confirming the website looks as expected with Vercel's preview
Merging the PR
Enjoying the updated website ;)
This course is only covering some basics of Docusaurus' capabilities. The official documentation is always available online to explain how to use other, more advanced features.
The general settings such as configuring your color theme, logo, footer/header links, and overall functionality are managed in the file called `docusaurus.config.js`. A detailed description of each available option is given in Docusaurus docs and in this video, you'll see a couple of examples.
Here we'll cover how to manage the markdown files corresponding to the documentation pages.
Do you want to share documentation / wiki / white paper / guide with the world? Many people still use plain PDFs, images, or unformatted chat messages that get outdated quickly and are not exciting.
i-o. fun/udemy
ACCESS THIS COURSE FOR FREE ! No joke, go to the web address above to access all of the learning materials for no cost at all. Why? I want more websites made with Docusaurus, and I figured. Understandable information should be publicly available. The new version is mostly text since I realized students are more likely to ACT if they read instead of watch. The new free version also includes a slightly improved workflow (use Codespaces instead of CodeSandbox).
The software's essential part is its documentation. Google, Facebook, and other big tech companies have well-structured and outstanding docs designed to share knowledge. Why don't we mimic the best?
The docs are so crucial that Facebook released its internal software called Docusaurus to open-source (made it free to use) so that everyone can present their knowledge with a high stacontinuously always available online:
they look readable on a device of any size,
support many languages with a click of a button,
and offer appropriate information for each software version (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
It's unsurprising if you haven't heard about Docusaurus before, as only developers have 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 handy tools like CodeSandbox requires zero coding knowledge to make his Docusaurus website
By completing the lectures:
You'll know how to host and version your content on GitHub
Make use of CodeSandbox to edit and preview the changes in real-time
Use Vercel to deliver the content as a website with your customized domain name
Additionally, your website will 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, including website translation, versioning, custom pages, and blogging support. However, this is a beginner course; we can't dive too deep. You can likely figure those features out by simply reading the official documents. If not, you can always ask us a question :)
Please be aware that changing the design and making custom landing pages (not part of documentation or blog) requires some basic coding knowledge and is not covered in this course. This being said the default design is already stunning, 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!