@@ -18,6 +18,7 @@ This guide will help you get started with contributing to the project, whether y
1818- [ Testing] ( #testing )
1919- [ Code Standards] ( #code-standards )
2020- [ Pull Request Process] ( #pull-request-process )
21+ - [ Documentation Contribution Setup] ( #documentation-contribution-setup )
2122
2223## Getting Started
2324
@@ -254,6 +255,74 @@ describe('YourClass', () => {
2542554 . ** Documentation** : Update docs for user-facing changes
2552565 . ** Examples** : Add examples for new features when applicable
256257
258+ ## Documentation Contribution Setup
259+
260+ ### Prerequisites
261+
262+ - ** Hugo Extended** (latest version) - Required for building the documentation site
263+
264+ ### Install Hugo
265+
266+ ** macOS:**
267+ ``` bash
268+ brew install hugo
269+ ```
270+
271+ ** Windows:**
272+ ``` bash
273+ choco install hugo-extended
274+ ```
275+
276+ ** Linux:**
277+ ``` bash
278+ # Download the latest Hugo extended from: https://github.com/gohugoio/hugo/releases
279+ # Or use snap
280+ sudo snap install hugo
281+ ```
282+
283+ ### Running Documentation Locally
284+
285+ 1 . ** Navigate to docs directory:**
286+ ``` bash
287+ cd docs/notion-to-md
288+ ```
289+
290+ 2 . ** Start the development server:**
291+ ``` bash
292+ hugo server -D
293+ ```
294+
295+ 3 . ** View the documentation:**
296+ Open ` http://localhost:1313 ` in your browser
297+
298+ ### Documentation Structure
299+
300+ ```
301+ docs/notion-to-md/
302+ ├── content/
303+ │ ├── docs/v4/ # Main API documentation
304+ │ ├── blog/ # Tutorials and guides
305+ │ └── catalogue/ # Plugin catalogue
306+ ├── static/ # Images and assets
307+ ├── themes/ # Hugo theme
308+ └── config.yaml # Site configuration
309+ ```
310+
311+ ### Making Documentation Changes
312+
313+ 1 . ** API Documentation** : Edit files in ` content/docs/v4/ `
314+ 2 . ** Tutorials/Guides** : Add new files to ` content/blog/ `
315+ 3 . ** Plugin Catalogue** : Update ` content/catalogue/ `
316+ 4 . ** Images** : Add to ` static/images/ `
317+
318+ ### Documentation Guidelines
319+
320+ - Use clear, concise language
321+ - Include working code examples
322+ - Test all code snippets before submitting
323+ - Follow the existing markdown structure
324+ - Add images to help explain complex concepts
325+
257326---
258327
259328Thank you for contributing to notion-to-md v4! Your efforts help make Notion content conversion better for everyone. 🚀
0 commit comments