From ac454497795840ffa2b85ccac540136f6bad7869 Mon Sep 17 00:00:00 2001 From: Nicolas Coden Date: Mon, 15 Jan 2018 23:49:31 +0100 Subject: [PATCH] docs: merge CLI and template installations --- docs/pages/installation.md | 102 +++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 56 deletions(-) diff --git a/docs/pages/installation.md b/docs/pages/installation.md index b0966f90e..6a4bb5683 100644 --- a/docs/pages/installation.md +++ b/docs/pages/installation.md @@ -112,78 +112,68 @@ npm install --global foundation-cli # or sudo npm install --global foundation-cli ``` -Then use to create a new Foundation project: - -```bash -foundation new -``` -
Depending on how your machine is configured, the command may fail with an `EACCESS` error. To get around this, run the commands with `sudo` at the beginning.
-
-

Foundation 5 users: if you already have the Foundation 5 CLI on your machine, you will only be able to access one of the commands, depending on how your command line environment is configured.

- -

To remove the Foundation 5 CLI, run gem uninstall foundation. After testing this new CLI, if you want to go back to the old CLI. To remove the Foundation 6 CLI, run npm uninstall foundation-cli --global.

-
- - ---- - -## Install with a template - -### Basic Template - -The basic template includes Foundation and a build process for Sass. - -To manually set up [the basic template](https://github.com/zurb/foundation-sites-template): +Then use to create a new Foundation project: ```bash -# Download the template with Git -git clone https://github.com/zurb/foundation-sites-template projectname - -# Move to the project folter, and install the needed dependencies -cd projectname -npm install - -# Build the Sass files -npm start +foundation new ``` -Your project will be recompiled every time you save a Sass file in `dist/. +After you selected "Foundation for Sites", Foundation CLI will ask you which template you want to use. You can choose between: +
+
+

Basic template

+

+ Recommended for beginners
+ A basic template to begin to use Foundation. It includes: +

    +
  • + Foundation for Sites pre-configured. +
  • +
  • + Sass compilation
    + A tool to convert your SASS/SCSS files to CSS. +
  • +
  • + Starter HTML file
    + A basic file to help you to use basic Foundation component (including the new XY grid !) +
  • +
+

+
-### ZURB Template - -The basic template includes Foundation and a build process with: -* Handlebars HTML templates with Panini -* Sass compilation and prefixing -* JavaScript module bundling with webpack -* Built-in BrowserSync -* Production build with CSS, Javascript and Image compression - -To manually set up [the ZURB template](https://github.com/zurb/foundation-zurb-template): - -```bash -# Download the ZURB template with Git -git clone https://github.com/zurb/foundation-zurb-template projectname - -# Move to the project folter, and install the needed dependencies -cd projectname -npm install +
+

ZURB template

+

+ Recommended for experienced (or curious) users
+ A more advanced project including Foundation and a build process with: +

    +
  • Handlebars HTML templates with Panini
  • +
  • Sass compilation and prefixing
  • +
  • JavaScript module bundling with webpack
  • +
  • Built-in BrowserSync
  • +
  • Production build with CSS, Javascript and Image compression
  • +
+

+
+
-# Build the project -npm start -``` +

+ See advanced Template installations +

-Your finished site will be created in a folder called `dist.`, viewable at this URL: [http://localhost:8000](http://localhost:8000) +
+

Foundation 5 users: if you already have the Foundation 5 CLI on your machine, you will only be able to access one of the commands, depending on how your command line environment is configured.

-To create compressed, production-ready assets, run `npm run build`. +

To remove the Foundation 5 CLI, run gem uninstall foundation. After testing this new CLI, if you want to go back to the old CLI. To remove the Foundation 6 CLI, run npm uninstall foundation-cli --global.

+
--- - ## Download
-- 2.47.2