From 64e6f160a99c971805e91945011a4da24419ebed Mon Sep 17 00:00:00 2001 From: imprakashsah <64677635+imprakashsah@users.noreply.github.com> Date: Thu, 1 Oct 2020 00:49:38 +0530 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1544c5d8b..58afbbc03 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ For larger changes, using the web-based editor on GitHub is not really convenien - [Bundler](http://bundler.io/) - a package manager for Ruby. Install it by running `gem install bundler` After you've forked and cloned the repository, run the following commands: - 1. `bundle install` - downloads the required libraries - 2. `bundle exec jekyll serve` - builds the website and runs a local webserver on port 4000 + 1. `bundle install` - downloads the required libraries. + 2. `bundle exec jekyll serve` - builds the website and runs a local webserver on port 4000. **Note:** you can add the `--watch` option when running `jekyll serve` to let Jekyll watch for file changes, which means the site will be rebuilt when a file is modified. @@ -45,22 +45,22 @@ The site should now be running locally: Repository structure -------------------- - - `_includes` - *special folder* contains snippets that can be included via `{% include file.html %}` in other pages + - `_includes` - *special folder* contains snippets that can be included via `{% include file.html %}` in other pages. - `_layouts` - *special folder* contains the layouts that are shared between pages. Layouts can be inherited, the root layout is `base.html`. - `_posts` - *special folder*, contains the source pages for the blog section, see [Writing a blog post](#writing-a-blog-post) - - `_site` - the output of the generated site is stored here by default, this folder only exists after Jekyll built the site - - `archived` - content that is no longer relevant but kept to keep external links working - - `community` - contains the source pages for the `/community` website section - - `css` - contains the main stylesheet - - `docs` - contains the source pages for the `/docs` website section - - `download` - contains the source pages for the `/download` website section - - `files` - stores binary files used in pages - - `images` - stores the images used in pages - - `news` - lists the blog pages from the `_posts` directory + - `_site` - the output of the generated site is stored here by default, this folder only exists after Jekyll built the site. + - `archived` - content that is no longer relevant but kept to keep external links working. + - `community` - contains the source pages for the `/community` website section. + - `css` - contains the main stylesheet. + - `docs` - contains the source pages for the `/docs` website section. + - `download` - contains the source pages for the `/download` website section. + - `files` - stores binary files used in pages. + - `images` - stores the images used in pages. + - `news` - lists the blog pages from the `_posts` directory. Writing a blog post ------------------- Blogging is very easy with Jekyll. Browse to `_posts` directory, copy the Markdown file `_TEMPLATE.md` and rename that file following the file name convention: `YEAR-MONTH-DAY-title.md`. Then open the file you renamed and follow the steps there to complete writing a blog post. -Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name. \ No newline at end of file +Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name.