Great!
You've just initialized a MarkBind site.

Let's get started...


You have just initialized a default MarkBind site! It is equipped with a set of core features, including site and page navigation. Additionally, we have included some convenient links to our User Guide, to help you get started quickly and easily.

If you were intending to convert an existing GitHub wiki or a docs folder into MarkBind, use the --convert flag instead. See User Guide: MarkBind in the Project Workflow for more information.

If you want to start with a template instead, use the --template flag with the "minimal" option to initialize a minimal site instead of the default. See User Guide: Templates for more information.


This default site comes pre-configured with the core Navigation components: a , a , a , and a Search Bar. To help you get started with the siteNav, we have included . The NavBar also comes with a placeholder slot for your custom Logo.


Guide to MarkBind

To see the capability of MarkBind in action, feel free to take a look at some of the websites built using MarkBind on our Showcase page.

For more information on how to work with MarkBind sites and to add content, refer to our comprehensive User Guide.

If you are interested in contributing to MarkBind, you can refer to our Developer Guide as well!

Good starting points in our User Guide

User Guide: Authoring Contents

Learn about the variety of syntax schemes, formats, and custom MarkBind components that you can use in your MarkBind site.

More info in: User Guide → Authoring Contents


User Guide: Working with Sites

Learn how to modify site properties, apply themes, and enable/disable plugins for your MarkBind site.

More info in: User Guide → Working with Sites


User Guide: Full Syntax Reference

Refer to our Full Syntax Reference page to find a specific feature or component that you want to use in your MarkBind site.

More info in: User Guide → Full Syntax Reference