Skip to content

Extract with inline settings

mkdocs.yml

# This is the simplest documentation site you could have.  
# It's just a simple readme.
site_name: ok-mkdocs-inline-settings
plugins:
  - simple

Input

ok-mkdocs-inline-settings/
├── hello_world.cpp
├── mkdocs.yml
└── README.md

hello_world.cpp

#include <iostream>

int main() {
  /** md file=main.md trim=2 stop="end-here"
  # Hello world

  This is the main function for hello world.
  It outputs "Hello World!" to the screen.

  end-here
  This shouldn't show up!
  **/
    std::cout << "Hello World!";
    return 0;
}

Output

site/
├── index.html
└── main/
    └── index.html

main

Hello world

This is the main function for hello world. It outputs "Hello World!" to the screen.