Giter VIP home page Giter VIP logo

mkdocs-orange's Introduction

Runs MkDocs server with any directories

Install

copy orange.sh in your $PATH.

Quick start

  1. run orange.sh add
  2. run orange.sh up
  3. open localhost:8000 in your browser

Usage

usage: orange.sh <command> [<args>]

  任意のディレクトリ群をマウントして
  lemonやorangeと同じ設定で MkDocs のライブサーバをdockerで起動する

  設定ファイル等は /Users/kei/.local/share/orange に保存する
  ライブサーバのアドレス/ポート番号は config.json で指定する

commands:
  add [--name <name>] [dir]
                       dirをnameとしてマウントする
                       dirを指定しない場合はカレントディレクトリを追加する
                       nameを指定しない場合はbasename dirの結果をnameにする
  rm name [name...]
                       nameをアンマウントする
  ls
  skip [--unset] name [name...]

  up                   docker-compose up を実行する
  reload               docker-compose down して up を実行する
  down                 docker-compose up を実行する
  config [--update]    docker-compose config を実行する
  logs                 docker-compose logs を実行する
  ps                   docker-compose ps を実行する
  doco                 docker-compose を実行する

  mkdocs [addr:]port
                       mkdocsのlistenアドレス/ポートを設定する
  plantuml [addr:]port
                       plantumlのlistenアドレス/ポートを設定する
                       コンテナの外から接続したい場合にのみ設定する
                       MkDocsコンテナはdockerのネットワークを使うので影響を受けない

mkdocs-orange's People

Contributors

takumakei avatar

Watchers

James Cloos 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.