Giter Site home page Giter Site logo

book-builder's Introduction

INSTRUCTION
-----------

This repository is for Advent of Sharing authors to collaborate to create the online/PDF bundle for all the AoS entries.

If you are not one of the authors, it's best to stay back and wait for the final release of the magazine.

If you are one of the author, do the following:

  1. Clone this repository to your local machine
  2. Add your entry to the ./data folder. The file name should be "day-<n>.md" where n is the day of your entry.
  3. Run the preview server with:
  	
	$ cd public && npx run serve

     You should have the web app running at http://localhost:3000
  4. Run the build script (in the project's root folder) with:
	
	$ npm run build

     The built content should be present in the ./public folder.
     As you working on your article, re-run the build script and hit F5 to see the updated content in the web app.
     (Yes, there is no hot reload or whatever the hell you think in this repo)

Finally, if you already happy with your entry, create a PR and wait until I come back from the vacation :v

P/S: The npm command does not work? Did I mention the "npm install" command?

book-builder's People

Contributors

huytd avatar quannt avatar tunah2 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.