Giter Club home page Giter Club logo

mkdocs-material-blog's Introduction

1. MkDocs Material Blog theme

Based on a popular Material theme for MkDocs static site generator, I added new layouts and customized some styles to show this site in a blog-like theme.

Please visit my blog at vuquangtrong.github.io to see this theme in live.

2. Prepare

  1. Clone this repo

  2. Run _new.bat to init a virtual environment

  3. Run activate the virtual environment

    Note that you are using virtual environment, next time when you start to edit this project, make sure to activate it first.

3. Installation

Run _install.bat to install required packages.

4. Configuration

Edit mkdocs.yaml to as your need!

5. Write docs

You can add your new documents in docs\blog.

Refer to Markdown syntax for writing documents.

6. Preview

  1. Run _run.bat
  2. Preview in browser at http://127.0.0.1:8000/

7. Publish

Run mkdocs build, then copy the content in the site folder to your website's serving folder.

8. Print to PDF

This function only work when you have Chrome and ChromeDrive installed and configured. For more detail, please visit Print to PDF plugin.

9. Preview

Homepage Blog posts An article Tag lists

10. License

MIT License Copyright (c) 2020-2021 Vu Quang Trong

mkdocs-material-blog's People

Contributors

vuquangtrong avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.