Hugo KB Structure & Pandoc Conversion Runbook
Part 1: Converting Word Docs to Hugo Markdown via Pandoc
Word files (.docx) can be quickly converted to Markdown natively using Pandoc. This preserves structural headings, lists, and basic formatting while outputting clean text files ready for Hugo.
Step 1: Install Pandoc on Ubuntu
Execute the following command in the terminal to fetch the latest stable release from the default package manager repositories:
+———————————————————————–+ | > sudo apt update\ | | > sudo apt install pandoc -y | +=======================================================================+ +———————————————————————–+
Step 2: Run the Native Pipeline Conversion
Change directory into the location where your source Microsoft Word file is hosted, and trigger the explicit flag-to-target pipeline:
+———————————————————————–+ | > pandoc -f docx -t markdown input_document.docx -o | | > output_document.md | +=======================================================================+ +———————————————————————–+
Step 3: Make it Hugo-Ready (Prepend Front Matter)
Open your fresh markdown file using nano or your text editor of choice, and place the YAML front matter block at the absolute top of the file:
+———————————————————————–+ | > ---\ | | > title: "My Converted IT Guide"\ | | > date: 2026-06-28\ | | > draft: false\ | | > categories: ["Guides"]\ | | > tags: ["SysAdmin", "Documentation"]\ | | > --- | +=======================================================================+ +———————————————————————–+
Part 2: Base File Requirements for Section Folders
To prevent broken rendering paths or missing navigation menus inside your custom 'cyber-kbb' workspace directory, apply these file schemas:
1. Content Folder Blueprint Structure
content/doc-preparing/_index.md: Serves as the root index wrapper for the doc conversion workflows documentation.
content/pentest/_index.md: Houses internal security evaluation logs, specialized checklists, and tool switches.
content/projects/_index.md: Acts as the playbook inventory for localized scripting projects, environment configurations, and background system daemons.
2. Section Templates Template Examples
Template for content/doc-preparing/_index.md
+———————————————————————–+ | > ---\ | | > title: "Documentation & Preparation"\ | | > date: 2026-06-28\ | | > description: "Workflows, tools, and automation scripts for | | > document parsing and formatting conversions."\ | | > draft: false\ | | > ---\ | | > \ | | > Welcome to the Document Preparation log. This section tracks tools | | > like Pandoc, markdown conversion pipelines, and document formatting | | > templates. | +=======================================================================+ +———————————————————————–+
Template for content/pentest/_index.md
+———————————————————————–+ | > ---\ | | > title: "Penetration Testing & Security"\ | | > date: 2026-06-28\ | | > description: "Security auditing notes, CEH methodologies, and | | > network exploitation cheat sheets."\ | | > draft: false\ | | > ---\ | | > \ | | > Core tracking for network architectures, target scanning protocols, | | > and zero-trust perimeter auditing. | +=======================================================================+ +———————————————————————–+
Template for content/projects/_index.md
+———————————————————————–+ | > ---\ | | > title: "Infrastructure Projects"\ | | > date: 2026-06-28\ | | > description: "Production logs for local automations, python | | > environments, and system daemons."\ | | > draft: false\ | | > ---\ | | > \ | | > Operational runbooks for deployed APIs, cron jobs, and background | | > services. | +=======================================================================+ +———————————————————————–+