diff options
| author | Silvano Sallese <silvano.sallese@gmail.com> | 2020-08-10 15:16:48 +0200 |
|---|---|---|
| committer | Silvano Sallese <silvano.sallese@gmail.com> | 2020-08-10 15:16:48 +0200 |
| commit | ebecb9c410f1e8f3fcc0e9d17d4b4be715d5ae57 (patch) | |
| tree | 01f3085c5b0ad9d575335f5804280dd972997882 /README.md | |
| parent | f99ee08af6c5a499cde827a66b2134d01471b8a4 (diff) | |
instructions update
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 13 insertions, 23 deletions
@@ -1,8 +1,8 @@ -# Particle Jekyll Theme +# Port for Zola of the [particle](https://github.com/nrandecker/particle) Jekyll theme - + -This is a simple and minimalist template for Jekyll designed for developers that want to show of their portfolio. +This is a simple and minimalist template for Zola designed for developers that want to show of their portfolio. The Theme features: @@ -17,52 +17,41 @@ The Theme features: ## Basic Setup -1. [Install Jekyll](http://jekyllrb.com) -2. Clone the particle theme: `git clone https://github.com/nrandecker/particle.git` -3. Edit `_config.yml` to personalize your site. +1. [Install Zola](https://getzola.com) +2. Clone the particle theme: `git clone https://github.com/svavs/particle-zola.git` +3. Edit `config.yml` to personalize your site. ## Site and User Settings -You have to fill some informations on `_config.yml` to customize your site. +You have to fill some informations on the `[extra]` section of the `config.yml` to customize your site. ``` # Site settings description: A blog about lorem ipsum dolor sit amet -baseurl: "" # the subpath of your site, e.g. /blog/ -url: "http://localhost:3000" # the base hostname & protocol for your site # User settings username: Lorem Ipsum user_description: Anon Developer at Lorem Ipsum Dolor user_title: Anon Developer -email: anon@anon.com +email: my@email.com twitter_username: lorem_ipsum github_username: lorem_ipsum gplus_username: lorem_ipsum ``` -**Don't forget to change your url before you deploy your site!** - ## Color and Particle Customization - Color Customization - - Edit the sass variables + - Edit the sass variables (`_vars.scss`) - Particle Customization - Edit the json data in particle function in app.js - Refer to [Particle.js](https://github.com/VincentGarreau/particles.js/) for help -## Running the blog in local - -In order to compile the assets and run Jekyll on local you need to follow those steps: - -- Install [NodeJS](https://nodejs.org/) -- Install [Jekyll](https://jekyllrb.com): `sudo gem install bundler jekyll` -- Install [Yarn](https://yarnpkg.com/): `npm install -g yarn` -- Install dependencies: `yarn` -- Run: `gulp` +To customize the project lists and the about sections, you need to edit the `templates/content.html` template file. +In future versions will be provided a simpler way. ## Questions -Having any issues file a [GitHub Issue](https://github.com/nrandecker/particle/issues/new). +Having any issues file a [GitHub Issue](https://github.com/svavs/particle-zola/issues/new). ## License @@ -71,5 +60,6 @@ This theme is free and open source software, distributed under the The MIT Licen ## Credits This theme was partially designed with the inspiration from these fine folks +- [Nathan Randecker](https://github.com/nrandecker/particle) - [Willian Justen](https://github.com/willianjusten/will-jekyll-template) - [Vincent Garreau](https://github.com/VincentGarreau/particles.js/) |