#Quick start guide
Installation is simple. First, make sure you have Node installed, then simply run:
npm install -g lfaIf it is easier for you, we also provide an official Docker distribution. Follow the instructions at the Docker Registry to get started.
Run the following command:
lfa new my-new-projectFollow the interactive instructions and a new project will be created for you in the my-new-project directory.
Move into the project:
cd my-new-projectThen start the watcher:
lfa watchA browser window will pop-up with your newly created project running inside. This page will automatically update as you edit and save files.
You may have noticed that your project is structured in directories:
ls
assets js styles mixins textEach has a particular function:
Every book is structured in chapters. Chapters are scrollable pages of text that the user consumes one at a time. Every .jade file in text/ is a chapter. Jade is a terser way of writing HTML. Read up on it.
Sometimes you may need to reuse blocks of code across your chapters. Jade has a feature called mixins. You can and should put your mixins in mixins/index.jade and then directly use them in your chapters.
You might have seen that we have some pre-defined mixins like +title and +subtitle. These are documented in the book module documentation.
We recommend that you learn SaSS's indented sintax. Write your SaSS rules in styles/main.sass.
js/index.js is your application's main Javascript entrypoint. We're using Webpack, so you can use require() to split your code into modules.
For more about what you can do in Javascript, read the reader core documentation
Throw images, sounds, videos, fonts or anything else in assets/. These files will be copied as they are to the output folder.
For example, if you place a photo of a kitten at assets/img/kitten.jpg, you can then use it in your chapters with img(src='img/kitten.jpg')
For a more detailed explaination of the ins and outs of a LFA project, read the documentation on Project structure