Skip to content

Commit 76ae474

Browse files
committed
copyedit content management page
1 parent 9223ba6 commit 76ae474

File tree

1 file changed

+28
-70
lines changed

1 file changed

+28
-70
lines changed

editor/content-management.mdx

Lines changed: 28 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,17 @@ title: "Managing content"
33
description: "Create, edit, and organize your documentation pages"
44
---
55

6-
Use the web editor to create new pages, edit existing content, and organize your documentation structure.
7-
86
## Navigating your files
97

10-
### File explorer
118
Use the sidebar file explorer to browse your documentation files. Click on any file to open it in the editor.
129

13-
### Quick file search
14-
Press <kbd>Command</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to quickly search and open files by name.
10+
Press <kbd>Command</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>P</kbd> on Windows) to search for files by name.
1511

1612
## Creating new pages
1713

1814
<Steps>
19-
<Step title="Open the file menu">
20-
Select the **Create a new file** icon (+ symbol) in the file explorer sidebar.
15+
<Step title="Create a new file">
16+
Select the **Create a new file** icon in the file explorer sidebar.
2117

2218
<img
2319
src="/images/editor/files-menu-light.png"
@@ -36,68 +32,24 @@ Press <kbd>Command</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd
3632
}}
3733
alt="Files menu in the web editor in dark mode"/>
3834
</Step>
39-
<Step title="Name your file">
40-
Enter a filename ending in `.mdx` (for example: `api-reference.mdx` or `getting-started.mdx`).
35+
<Step title="Enter a filename">
36+
Filenames must end in `.mdx`. For example, `api-reference.mdx` or `getting-started.mdx`.
4137
</Step>
4238
<Step title="Create and open">
43-
Press <kbd>Enter</kbd> to create the file. It will open automatically in the editor, ready for content.
39+
Press <kbd>Enter</kbd> to create the file. It will open automatically in the editor, ready for content to be added.
4440
</Step>
4541
</Steps>
4642

47-
Your new page needs frontmatter (metadata) at the top to display properly. Add this structure:
48-
49-
```yaml
50-
---
51-
title: "Your page title"
52-
description: "Brief description for SEO and navigation"
53-
---
54-
```
55-
56-
## Editing content
57-
58-
### Using visual mode
59-
60-
Visual mode shows you exactly how your content will appear on your documentation site. It's perfect for:
61-
62-
- Writing and formatting text
63-
- Adding images and media
64-
- Creating lists and tables
65-
- Inserting components without knowing the syntax
66-
67-
**Adding components**: Press <kbd>/</kbd> to open the component menu. Choose from callouts, code blocks, accordions, and other Mintlify components.
68-
69-
<Frame>
70-
<img
71-
src="/images/editor/component-menu-light.png"
72-
alt="The unfurled component menu emphasized in the Mintlify web editor"
73-
className="block dark:hidden"
74-
/>
75-
<img
76-
src="/images/editor/component-menu-dark.png"
77-
alt="The unfurled component menu emphasized in the Mintlify web editor"
78-
className="hidden dark:block"
79-
/>
80-
</Frame>
81-
82-
### Using Markdown mode
83-
84-
Markdown mode gives you direct access to the MDX source code. Use this when you need to:
85-
86-
- Set specific component properties
87-
- Work with complex nested components
88-
- Copy and paste MDX content from other sources
89-
- Fine-tune formatting and spacing
90-
9143
## Organizing your navigation
9244

93-
Add new pages to your site navigation by editing the `docs.json` file:
45+
Add new pages to your site navigation by editing your `docs.json` file.
9446

9547
<Steps>
9648
<Step title="Open docs.json">
9749
Find and open the `docs.json` file in your root directory using the file explorer.
9850
</Step>
9951
<Step title="Locate the navigation section">
100-
Find the `navigation` property in the JSON structure.
52+
Find the spot in the `docs.json` file where you want to add your new page.
10153
</Step>
10254
<Step title="Add your page">
10355
Insert your page filename (without the `.mdx` extension) in the appropriate group's `pages` array.
@@ -132,21 +84,27 @@ Add new pages to your site navigation by editing the `docs.json` file:
13284
}
13385
```
13486

135-
See the [Navigation](/navigation) documentation for advanced navigation options.
87+
## Editing content
88+
89+
Make changes to your pages using visual mode or Markdown mode in the editor.
13690

137-
## Content best practices
91+
In visual mode, press <kbd>/</kbd> to open the component menu. Add content blocks, callouts, code blocks, and other components to customize your documentation.
13892

139-
### Writing effective titles and descriptions
140-
- **Title**: Be specific and descriptive
141-
- **Description**: Write 1-2 sentences explaining what users will learn or accomplish
93+
<Frame>
94+
<img
95+
src="/images/editor/component-menu-light.png"
96+
alt="The unfurled component menu emphasized in the Mintlify web editor"
97+
className="block dark:hidden"
98+
/>
99+
<img
100+
src="/images/editor/component-menu-dark.png"
101+
alt="The unfurled component menu emphasized in the Mintlify web editor"
102+
className="hidden dark:block"
103+
/>
104+
</Frame>
142105

143-
### Structuring your content
144-
- Start with the most important information
145-
- Use headings to break up long sections
146-
- Include examples and code snippets where helpful
147-
- End with next steps or related links
106+
In Markdown mode, you can directly edit the `MDX` of your pages. This can be helpful when you need to:
148107

149-
### File organization
150-
- Group related pages in folders (like `/api/` or `/guides/`)
151-
- Use consistent naming conventions
152-
- Keep filenames short but descriptive
108+
- Set specific component properties
109+
- Work with complex nested components
110+
- Copy and paste `MDX` content from other sources

0 commit comments

Comments
 (0)