⏮️ Semester in Review​

Its been a great semester and I hope everyone found this site helpful.

📂 Open Source​

The project will continue to be Open Source, welcoming contributions from individuals. You can submit a PR with new sections for review. To facilitate contributions, I will establish clear contributing guidelines, enabling even first-time OS contributors to enhance the project.

V3 features​

Exciting features are in the pipeline for v3, and I am committed to delivering them promptly.

📚 Notes Repository​

I am also developing a portal for easy access to all college-related academic documents, including notes and answer keys for various upcoming topics.

The repository for notes site is on https://github.com/TejasBhovad/notes

🚀 Future plans and Roadmap​

To find the roadmap of this project refer https://codes.super.site/

We are also working on a way to take you feedback/bug reports easily so stay tuned.

Docusaurous is an easy to use documentation tool bey Meta. In this article we will look into how to build a basic Docusaurous site and add Search bar to it.

If you prefer a video tutorial, I have a 3 minute video on the same

Step 1: Basic Docs Setup​

Head to https://docusaurus.io/docs#fast-track Copy the installation command from the above page.

Open VS Code, and open the terminal, paste the copied command and let the site build

If the installation doesn't proceed and is stuck, press ctr+c to terminate current session and run npm i to install the node modules

run npm run start to start development server, a window will automatically appear in your default web browser

Step 2: Setting up Local Search​

Now, Docusaurous doesn't have a built in search bar, it does officially have partnership with Algolia search, but it requires a particular checklist to be satisfied. We will be using an open source alternative: https://github.com/easyops-cn/docusaurus-search-local Head to https://github.com/easyops-cn/docusaurus-search-local?tab=readme-ov-file#installation and copy installation code, and paste it in the terminal

Now in the usage section https://github.com/easyops-cn/docusaurus-search-local?tab=readme-ov-file#usage, copy the following code

  plugins: [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      ({
        hashed: true,
      }),
    ],

And paste it into the config section in docusaurus.config.js file Restart the dev server and search bar should appear in the top right

The Search will not work in development server, to test it, you need to build the site.

Build the site

npm run build

Serve the site

npm run serve

Thanks for reading.

Today, I am excited to announce Docs 2.0 🥳

Docs 2.0 is a complete rewrite of the Old Docs site and has added a lot of new features and improvements.

New Features​

• Built-in Search: Docs 2.0 features a lightning-fast search powered by easyops-local-search. Access it using command + k.
• Dark Mode: Easily toggle the site's dark mode by clicking the moon icon in the top right corner.
• Semester Dropdown: Navigate between semesters effortlessly with the new dropdown menu.
• Popular and Featured: The homepage now includes sections showcasing popular and featured pages for quick access.

Blogs​

A blog section has been added to the site that will be used to post updates about the site and other announcements. It will also serve as a channel for posting articles related to programming and technology that were previously posted on the Medium.

Open Source​

Docs 2.0 is completely open source and is available on GitHub. Feel free to contribute to the site by opening a pull request.

2023 - Year in Review​

Almost 800 users have visited the site since its launch in Jan 2023 and it amounted to almost 30k views.