Skip to main content

Edit and Delete Documentation Article

After you have created articles, you will need to edit and manage them from time to time. Content changes, typos happen, and sometimes a page is no longer needed. This guide shows how to update and delete docs.

Edit / Update Article​

To edit an existing article:

Step 1: Find the Article File​

Open your project in VS Code and go to:

docs/your-group/

For example:

docs/getting-started/installation.md

Step 2: Open and Edit​

Open the .md file in VS Code.

You can edit two parts:

  1. Frontmatter (the top part between ---):
---
title: Installation
description: How to install Docusar template
image: img/docusaurus.png
sidebar_position: 3
---
  • Change title to update the article title
  • Change description for SEO
  • Change sidebar_position to move the order in the sidebar (1 = top)
  1. Content (below the frontmatter):

Edit the markdown content, add new sections, fix typos, add images.

Example change from:

# Installation

Run npm install

To:

# Installation Guide

This is a complete installation guide for Docusar.

## Requirements

- Node.js 18+
- VS Code

## Install

Run `npm install` to install dependencies.

Step 3: Save and Check​

  1. Save the file (Ctrl+S)
  2. If npm run start is running, your browser auto-refreshes - check the changes at http://localhost:3000
  3. If it is not running, run npm run start to preview

Tip: You do not need to restart the server for md file changes - Docusaurus hot reloads automatically.

Delete Article​

To delete a documentation article:

Step 1: Find the File​

Go to:

docs/your-group/your-article.md

Example:

docs/getting-started/old-article.md

Step 2: Delete the File​

  • Right-click the file in VS Code → Delete
  • Or delete it from File Explorer

That is it. The file is deleted.

Step 3: Verify​

  1. Run npm run start
  2. Check the sidebar - the deleted article should no longer appear
  3. If you try to visit its old URL /docs/getting-started/old-article, you will get a 404 - this is normal

Rename Article​

To rename an article:

  1. Rename the file: installation.md → install-guide.md - the URL changes to /docs/.../install-guide
  2. Also update the title in the frontmatter to match the new name
  3. If you have links to the old file from other docs, update those links too

Important:

  • Never delete _category_.json unless you want to delete the whole category group
  • If you delete all .md files in a group, the category will show an empty page
  • Always keep at least one .md file per group