Git Product home page Git Product logo

konecty.docs.generator's Introduction

Usage

Install dependencies using npm:

npm i

Fetch the Konecty.Docs source files, into a src directory or you could also symlink a local copy of the docs repo instead of fetching it, e.g. ln -s ../Konecty.Docs src - assuming docs were pulled as a sibling to the generator.

Compile assets and serve the transformed pages locally:

npm run serve

It will also create a build directory with the static pages.

Workflow

  1. Make edits to the files in src directory
  2. metalsmith will hot reload and compile your changes
  3. Test using a browser
  4. Repeat 1 if required
  5. git push the tested final changes back to Konecty.Docs

Note

If you are adding files or directories to the docs, the hot reload will not see those files/directories until you restart gulp.

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.