Giter Club home page Giter Club logo

mdstatic's Introduction

mdStatic

Build a simple and lightweight static website with markdown

Quick start

  • Clone this repository
  • Change "Your site name" in index.html and src/js/all.js
  • Do npm install
  • Then open index.html in your browser, the page is ready!
  • Deploy to any hosting service or gh-pages

Change content

Your content is in /md/[lang]/. You may add new files and/or folders.

The URL of /md/[lang]/path/to/content.md will be index.html#x/path/to/content

When the user accesses index.html without suffix, /md/[lang]/home.md is loaded.

Menu and languages

Top menu structure and language list is defined by menu.json. Here is a short example:

{
    "ja": {
        "c": "日本語",
        "m": [{
            "t": "ホーム",
            "u": ""
        }, {
            "t": "プロフィール",
            "u": "about"
        }]
    },
    "en": {
        "c": "English",
        "m": [{
            "t": "Home",
            "u": ""
        }, {
            "t": "About me",
            "u": "about"
        }]
    },
    "lang-code": {
        "c": "Lang-name",
        "m": [{
            "t": "item text",
            "u": "link url"
        }]
    }
}

mdstatic's People

Contributors

dependabot[bot] avatar plageoj 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.