Meta tags:
author=MkDocs Team;

Headings (most frequently used words):

getting, the, started, with, mkdocs, installation, creating, new, project, adding, pages, theming, our, documentation, changing, favicon, icon, building, site, other, commands, and, options, deploying, help, search, keyboard, shortcuts,

Text of the page (most frequently used words):
the (63), your (29), mkdocs (27), and (26), you (24), documentation (22), #search (13), site (13), file (13), that (12), configuration (11), for (10), directory (10), docs (10), about (10), page (9), command (9), theme (9), help (8), with (8), see (8), getting (7), index (7), will (7), guide (6), new (6), mklorum (6), project (6), from (5), use (5), options (5), html (5), named (5), icon (5), favicon (5), changes (5), site_name (5), home (5), now (5), yml (5), info (5), started (5), built (4), deploying (4), build (4), other (4), commands (4), source (4), add (4), line (4), save (4), setting (4), installation (4), previous (3), next (3), open (3), get (3), github (3), all (3), user (3), files (3), list (3), available (3), run (3), following (3), want (3), been (3), create (3), take (3), building (3), default (3), changing (3), nav (3), change (3), edit (3), our (3), items (3), pages (3), navigation (3), adding (3), browser (3), server (3), this (2), close (2), more (2), complete (2), just (2), only (2), uses (2), specific (2), flag (2), there (2), various (2), using (2), code (2), control (2), check (2), how (2), gitignore (2), into (2), notice (2), has (2), also (2), have (2), part (2), sitemap (2), xml (2), license (2), img (2), first (2), readthedocs (2), being (2), displayed (2), theming (2), try (2), then (2), any (2), text (2), include (2), term (2), right (2), some (2), option (2), should (2), immediately (2), reload (2), initial (2), auto (2), dev (2), http (2), 127 (2), 8000 (2), serve (2), single (2), folder (2), creating (2), install (2), developer (2), action, keys, keyboard, shortcuts, here, can, these, documents, enter, terms, below, copyright, 2014, maintained, team, tom, christie, please, issues, discussions, features, static, able, host, pretty, much, anywhere, simply, upload, contents, entire, wherever, hosting, website, done, instructions, number, common, hosts, view, given, example, are, another, tool, its, ignore, directories, echo, such, probably, don, builds, repository, containing, git, output, two, media, copied, even, search_index, json, fonts, css, look, inside, looking, good, ready, deploy, pass, different, subdirectory, copy, custom, automatically, detect, ico, used, alter, menu, navigate, back, forth, between, click, dialog, appear, allowing, results, every, occurrence, links, directly, section, which, appears, effort, bar, left, well, headers, may, information, order, title, nesting, each, header, curl, https, jaspervdj, lorem, markdownum, markdown, txt, second, required, note, name, effect, editing, document, editor, choice, heading, updated, supports, reloading, rebuild, whenever, anything, cleaning, seconds, watching, paths, serving, comes, lets, preview, work, make, sure, same, start, running, contain, value, contains, docs_dir, moment, review, created, super, easy, details, pip, introductory, tutorial, contributing, release, notes, api, reference, plugins, translations, themes, interface, localizing, customizing, choosing, writing,

Text of the page (random words):
getting started mkdocs mkdocs home getting started user guide user guide installation writing your docs choosing your theme customizing your theme localizing your theme configuration command line interface deploying your docs developer guide developer guide themes translations plugins api reference about release notes contributing license search previous next edit on github getting started with mkdocs installation creating a new project adding pages theming our documentation changing the favicon icon building the site other commands and options deploying getting help getting started with mkdocs an introductory tutorial installation to install mkdocs run the following command from the command line pip install mkdocs for more details see the installation guide creating a new project getting started is super easy to create a new project run the following command from the command line mkdocs new my project cd my project take a moment to review the initial project that has been created for you there s a single configuration file named mkdocs yml and a folder named docs that will contain your documentation source files docs is the default value for the docs_dir configuration setting right now the docs folder just contains a single documentation page named index md mkdocs comes with a built in dev server that lets you preview your documentation as you work on it make sure you re in the same directory as the mkdocs yml configuration file and then start the server by running the mkdocs serve command mkdocs serve info building documentation info cleaning site directory info documentation built in 0 22 seconds info 15 50 43 watching paths for changes docs mkdocs yml info 15 50 43 serving on http 127 0 0 1 8000 open up http 127 0 0 1 8000 in your browser and you ll see the default home page being displayed the dev server also supports auto reloading and will rebuild your documentation whenever anything in the configuration file documentation directory or theme directory changes open the docs index md document in your text editor of choice change the initial heading to mklorum and save your changes your browser will auto reload and you should see your updated documentation immediately now try editing the configuration file mkdocs yml change the site_name setting to mklorum and save the file site_name mklorum your browser should immediately reload and you ll see your new site name take effect note the site_name configuration option is the only required option in your configuration file adding pages now add a second page to your documentation curl https jaspervdj be lorem markdownum markdown txt docs about md as our documentation site will include some navigation headers you may want to edit the configuration file and add some information about the order title and nesting of each page in the navigation header by adding a nav setting site_name mklorum nav home index md about about md save your changes and you ll now see a navigation bar with home and about items on the left as well as search previous and next items on the right try the menu items and navigate back and forth between pages then click on search a search dialog will appear allowing you to search for any text on any page notice that the search results include every occurrence of the search term on the site and links directly to the section of the page in which the search term appears you get all of that with no effort or configuration on your part theming our documentation now change the configuration file to alter how the documentation is displayed by changing the theme edit the mkdocs yml file and add a theme setting site_name mklorum nav home index md about about md theme readthedocs save your changes and you ll see the readthedocs theme being used changing the favicon icon by default mkdocs uses the mkdocs favicon icon to use a different icon create an img subdirectory in the docs directory and copy your custom favicon ico file to that directory mkdocs will automatically detect and use that file as your favicon icon building the site that s looking good you re ready to deploy the first pass of your mklorum documentation first build the documentation mkdocs build this will create a new directory named site take a look inside the directory ls site about fonts index html license search html css img js mkdocs sitemap xml notice that your source documentation has been output as two html files named index html and about index html you also have various other media that s been copied into the site directory as part of the documentation theme you even have a sitemap xml file and mkdocs search_index json if you re using source code control such as git you probably don t want to check your documentation builds into the repository add a line containing site to your gitignore file echo site gitignore if you re using another source code control tool you ll want to check its documentation on how to ignore specific directories other commands and options there are various other commands and options available for a complete list of commands use the help flag mkdocs help to view a list of options available on a given command use the help flag with that command for example to get a list of all options available for the build command run the following mkdocs build help deploying the documentation site that you just built only uses static files so you ll be able to host it from pretty much anywhere simply upload the contents of the entire site directory to wherever you re hosting your website from and you re done for specific instructions on a number of common hosts see the deploying your docs page getting help see the user guide for more complete documentation of all of mkdocs features to get help with mkdocs please use the github discussions or github issues copyright 2014 tom christie maintained by the mkdocs team documentation built with mkdocs search close from here you can search these documents enter your search terms below keyboard shortcuts close keys action open this help n next page p previous page s search