Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imprakashsah wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name.