Git Product home page Git Product logo

kylo-docs-test's Introduction

Getting Started With Kylo Documentation

Install Sphinx and Pandoc

$ brew install python

$ sudo pip install sphinx

$ sudo pip install sphinx-autobuild

List how to install pandoc

Adding Documents

There are two methods for creating new documents.

  1. Create a word document and convert to RST
  2. Start from RST directly

Option 1: Convert Docx to RST

  1. Author a word document
  2. Run Pandoc to convert

$ pandoc -f docx NameofFile.docx -t rst -o NameofFile.rst

  1. List next steps here

Option 2: Start with RST

  1. Create RST document by making a new file with the "rst" extension
  2. Run "make html" to rebuild the HTML locally.
  3. View the HTML file in the _build folder to

kylo-docs-test's People

Contributors

rarwriter avatar jeremymerrifield avatar

Watchers

James Cloos avatar  avatar

Forkers

guptam maduhu

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.