bulma/docs/bulma-start.html

86 lines
3.6 KiB
HTML
Raw Normal View History

2017-10-17 13:06:45 +00:00
---
2018-04-10 17:50:19 +00:00
title: "Bulma start"
2017-10-17 13:06:45 +00:00
fulltitle: "Bulma start: a tiny npm package to get started with Bulma"
2018-04-10 17:50:19 +00:00
layout: more
2017-10-17 13:06:45 +00:00
route: bulma-start
2019-02-07 19:22:21 +00:00
version: 0.0.3
download_url: https://github.com/jgthms/bulma-start/releases/download/0.0.3/bulma-start-0.0.3.zip
2017-10-17 13:06:45 +00:00
github_url: https://github.com/jgthms/bulma-start
npm_url: https://www.npmjs.com/package/bulma-start
2018-04-10 17:50:19 +00:00
breadcrumb:
- home
- more
- bulma-start
2017-10-17 13:06:45 +00:00
---
2018-04-10 17:50:19 +00:00
<div class="columns">
<div class="column is-5-widescreen">
2019-02-07 19:22:21 +00:00
<p class="title is-4">
<code><a target="_blank" href="{{ page.npm_url }}">bulma-start</a></code> is a tiny npm package that includes the <code>npm</code> <strong>dependencies</strong> you need to <strong>build your own website</strong> with Bulma.
</p>
2018-04-10 17:50:19 +00:00
<div class="buttons">
2019-02-07 19:22:21 +00:00
<a class="button is-medium is-success" target="_blank" href="{{ page.download_url }}">
<span><strong>Download v{{ page.version }}</strong></span>
</a>
2017-10-17 13:06:45 +00:00
</div>
2019-02-07 19:22:21 +00:00
2018-04-10 17:50:19 +00:00
<div class="buttons">
2019-02-07 19:22:21 +00:00
<a class="button is-small is-outlined is-dark" target="_blank" href="{{ page.github_url }}">
<span><strong>GitHub</strong> page</span>
</a>
<a class="button is-small is-outlined is-danger" target="_blank" href="{{ page.npm_url }}">
<span><strong>npm</strong> page</span>
</a>
2017-10-17 13:06:45 +00:00
</div>
2018-04-10 17:50:19 +00:00
</div>
2019-02-07 19:22:21 +00:00
2018-04-10 17:50:19 +00:00
<div class="column is-narrow">
2019-02-07 19:22:21 +00:00
<p>
<a href="{{ page.npm_url }}">
<img src="{{ site.url }}/images/bulma-start.png" alt="Bulma: a Flexbox CSS framework" style="max-width:100%;" width="438" height="200">
</a>
</p>
2018-04-10 17:50:19 +00:00
</div>
</div>
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
{% include elements/anchor.html name="Install" %}
2017-10-17 13:06:45 +00:00
2019-02-07 18:32:22 +00:00
<div class="content">
<p>
2019-02-07 19:22:21 +00:00
<a href="{{ page.download_url }}" rel="nofollow noopener"><strong>Download bulma-start {{ page.version }} (.zip)</strong></a>, rename to your project's name (i.e. <code>my-new-bulma-site</code>) and:
2019-02-07 18:32:22 +00:00
</p>
</div>
2017-10-17 13:06:45 +00:00
{% highlight bash %}
cd my-new-bulma-site
npm install
npm start
{% endhighlight %}
2017-10-17 13:06:45 +00:00
For more, visit <a href="https://github.com/jgthms/bulma-start#get-your-feet-wet">bulma-start README on Github.</a>
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
{% include elements/anchor.html name="Whats included" %}
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
<div class="content">
<p>The <code>npm</code> dependencies included in <code>package.json</code> are:</p>
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
<ul>
<li><code><a href="https://github.com/jgthms/bulma" target="_blank">bulma</a></code></li>
<li><code><a href="https://github.com/sass/node-sass" target="_blank">node-sass</a></code> to compile your own Sass file</li>
<li><code><a href="https://github.com/postcss/postcss-cli" target="_blank">postcss-cli</a></code> and <code><a href="https://github.com/postcss/autoprefixer" target="_blank">autoprefixer</a></code> to add support for older browsers</li>
<li><code><a href="https://babeljs.io/docs/usage/cli/" target="_blank">babel-cli</a></code>, <code><a href="https://github.com/babel/babel-preset-env" target="_blank">babel-preset-env</a></code> and <code><a href="https://github.com/jmcriffey/babel-preset-es2015-ie">babel-preset-es2015-ie</a></code> for compiling ES6 JavaScript files</li>
</ul>
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
<p>Apart from <code>package.json</code>, the following files are included:</p>
2017-10-17 13:06:45 +00:00
2018-04-10 17:50:19 +00:00
<ul>
<li><code>.babelrc</code> configuration file for <a href="https://babeljs.io/">Babel</a></li>
<li><code>.gitignore</code> common <a href="https://git-scm.com/">Git</a> ignored files</li>
<li><code>index.html</code> this HTML5 file</li>
<li><code>_sass/main.scss</code> a basic SCSS file that <strong>imports Bulma</strong> and explains how to <strong>customize</strong> your styles, and compiles to <code>css/main.css</code></li>
<li><code>_javascript/main.js</code> an ES6 JavaScript that compiles to <code>lib/main.js</code></li>
</ul>
</div>