Skip to content

Commit 65b5b00

Browse files
committed
remove about
1 parent 65d740c commit 65b5b00

File tree

1 file changed

+0
-351
lines changed

1 file changed

+0
-351
lines changed

about.md

-351
Original file line numberDiff line numberDiff line change
@@ -3,354 +3,3 @@ layout: page
33
title: "About"
44
permalink: /about/
55
---
6-
7-
whiteglass is a minimal, responsive Jekyll theme for hackers.
8-
9-
## Installation
10-
11-
Add this line to your Jekyll site's Gemfile:
12-
13-
``` ruby
14-
gem "jekyll-whiteglass"
15-
```
16-
17-
And add this line to your Jekyll site's `_config.yml`:
18-
19-
``` yaml
20-
theme: jekyll-whiteglass
21-
```
22-
23-
And then execute:
24-
25-
``` sh
26-
bundle
27-
```
28-
29-
Or install it yourself as:
30-
31-
``` sh
32-
gem install jekyll-whiteglass
33-
```
34-
35-
## Quick Start
36-
37-
1. Go to [yous/whiteglass-template](https://github.com/yous/whiteglass-template).
38-
2. Click "Use this template" button, and then create a repository.
39-
3. Change the options defined in _config.yml. See [Configuration](https://github.com/yous/whiteglass-template#configuration)
40-
section under whiteglass-template.
41-
5. Push some content, then GitHub Actions will generate the site.
42-
43-
## Manual Setup
44-
45-
1. Generate a new Jekyll blog:
46-
47-
``` sh
48-
jekyll new blog --skip-bundle
49-
cd blog
50-
```
51-
52-
2. Edit `Gemfile` to use whiteglass theme:
53-
54-
``` ruby
55-
gem "jekyll-whiteglass"
56-
```
57-
58-
3. Edit `_config.yml` to use whiteglass theme and its plugins:
59-
60-
``` yaml
61-
theme: jekyll-whiteglass
62-
plugins:
63-
- jekyll-archives
64-
- jekyll-paginate
65-
- jekyll-sitemap
66-
67-
permalink: /:year/:month/:day/:title/
68-
paginate_path: /posts/:num/
69-
paginate: 5
70-
71-
jekyll-archives:
72-
enabled:
73-
- categories
74-
- tags
75-
layout: category_archives
76-
permalinks:
77-
category: /categories/:name/
78-
tag: /tags/:name/
79-
```
80-
81-
4. Copy
82-
[`index.html`](https://github.com/yous/whiteglass/blob/master/index.html),
83-
[`about.md`](https://github.com/yous/whiteglass/blob/master/about.md),
84-
[`archives.md`](https://github.com/yous/whiteglass/blob/master/archives.md),
85-
[`feed.xml`](https://github.com/yous/whiteglass/blob/master/feed.xml),
86-
[`robots.txt`](https://github.com/yous/whiteglass/blob/master/robots.txt),
87-
[`_data/i18n.yml`](https://github.com/yous/whiteglass/blob/master/_data/i18n.yml),
88-
and [`_data/navigation.yml`](https://github.com/yous/whiteglass/blob/master/_data/navigation.yml)
89-
from the theme:
90-
91-
``` sh
92-
rm index.md
93-
curl -L -O "https://github.com/yous/whiteglass/raw/master/{index.html,about.md,archives.md,feed.xml,robots.txt}"
94-
curl -L --create-dirs -o _data/#1 "https://github.com/yous/whiteglass/raw/master/_data/{navigation.yml,i18n.yml}"
95-
```
96-
97-
5. Install gems and you're good to go! The blog will be available on
98-
`http://127.0.0.1:4000`.
99-
100-
``` sh
101-
bundle install
102-
bundle exec jekyll serve
103-
```
104-
105-
## Upgrading
106-
107-
### From Version < 1.9.1
108-
109-
Copy
110-
[`_data/i18n.yml`](https://github.com/yous/whiteglass/blob/master/_data/i18n.yml)
111-
from the theme.
112-
113-
## Deployment to GitHub Pages using Travis CI
114-
115-
This theme uses [jekyll-archives](https://github.com/jekyll/jekyll-archives) gem
116-
which is [not supported by GitHub Pages](https://help.github.com/articles/configuring-jekyll-plugins/).
117-
If you want to use full features like categories and tags, I recommend you to
118-
use Travis CI or other CI services.
119-
120-
To deploy using Travis CI, first copy the [`.travis.yml`](https://github.com/yous/whiteglass/blob/master/.travis.yml)
121-
of this repository. You can change `target-branch` (`gh-pages` by default) and
122-
`on.branch` (`master` by default) as you want. If you want further
123-
customization, see [Travis CI's documentation page](https://docs.travis-ci.com/user/deployment/pages/).
124-
125-
You'll see there's `github-token: $GITHUB_TOKEN`, and this is what you should
126-
configure. Go to your [personal access tokens](https://github.com/settings/tokens)
127-
page, and generate new token with `public_repo` or `repo` permission as you
128-
need. Then go to Travis CI's settings page of your repository, and add a new
129-
environment variable `GITHUB_TOKEN` with the value of the token you generated.
130-
131-
## Usage
132-
133-
### Customization
134-
135-
To override the default structure and style of whiteglass, simply create the
136-
concerned directory at the root of your site, copy the file you wish to
137-
customize to that directory, and then edit the file. e.g., to override the
138-
[`_includes/footer_content.html`](_includes/footer_content.html) file to add
139-
contents to footer, create an `_includes` directory, copy
140-
`_includes/footer_content.html` from jekyll-whiteglass gem folder to
141-
`<your-site>/_includes` and start editing that file.
142-
143-
For example, you can add favicons to `_includes/head_custom.html`:
144-
145-
``` html
146-
<link rel="icon" type="image/x-icon" href="{{ "/favicon.ico" | relative_url }}">
147-
<link rel="apple-touch-icon" href="{{ "/apple-touch-icon.png" | relative_url }}">
148-
<link rel="apple-touch-icon" sizes="76x76" href="{{ "/apple-touch-icon-76x76.png" | relative_url }}">
149-
<link rel="apple-touch-icon" sizes="120x120" href="{{ "/apple-touch-icon-120x120.png" | relative_url }}">
150-
<link rel="apple-touch-icon" sizes="152x152" href="{{ "/apple-touch-icon-152x152.png" | relative_url }}">
151-
<link rel="apple-touch-icon" sizes="180x180" href="{{ "/apple-touch-icon-180x180.png" | relative_url }}">
152-
```
153-
154-
The site's default CSS is in the gem itself,
155-
[`assets/main.scss`](assets/main.scss). To override the default CSS, the file
156-
has to exist at your site source. Do either of the following:
157-
158-
- Create a new instance of `main.scss` at site source
159-
- Create a new file `main.scss` at `<your-site>/assets/`
160-
- Add the frontmatter dashes, and
161-
- Add `@import "whiteglass";`, to `<your-site>/assets/main.scss`
162-
- Add your custom CSS
163-
- Download the file from this repo
164-
- Create a new file `main.scss` at `<your-site>/assets/`
165-
- Copy the contents at [`assets/main.scss`](assets/main.scss) onto the `main.scss` you just created, and edit away
166-
- Copy directly from jekyll-whiteglass gem
167-
- Go to your local jekyll-whiteglass gem installation directory (run `bundle show jekyll-whiteglass` to get the path to it)
168-
- Copy the `assets/` folder from there into the root of `<your-site>`
169-
- Change whatever values you want, inside `<your-site>/assets/main.scss`
170-
171-
### Locale
172-
173-
`site.lang` is used to declare the primary language for each web page within the
174-
site.
175-
176-
`lang: en-US` sets the `lang` attribute for the site to the United States flavor
177-
of English, while `en-GB` would be for the United Kingdom style of English.
178-
Country codes are optional and the shorter variation `lang: en` is also
179-
acceptable. You may want to write a post in different language, then add `lang`
180-
attribute to the frontmatter of that post:
181-
182-
``` yaml
183-
layout: post
184-
title: "안녕하세요"
185-
lang: ko
186-
```
187-
188-
The date format and other fixed strings are translated using the `_data/i18n.yml` file. If your language is not yet included, feel free to open a [pull request](https://github.com/yous/whiteglass/pulls).
189-
190-
### Description
191-
192-
`site.description` describes the site. This is mainly used in meta descriptions
193-
for improving SEO. Also, you can set `description` attribute for each post:
194-
195-
``` yaml
196-
layout: post
197-
title: Awesome Post
198-
description: This is an awesome post.
199-
```
200-
201-
If you don't specify `post.description`, then `post.excerpt` will be used if it
202-
exist.
203-
204-
### External URL
205-
206-
`external-url` turns the title of your post to a link. Specify a URL which you
207-
want to link to.
208-
209-
``` yaml
210-
layout: post
211-
title: Jekyll whiteglass theme
212-
external-url: https://github.com/yous/whiteglass
213-
```
214-
215-
Then the title of your post would look like a link with text
216-
`Jekyll whiteglass theme →`. This also applies to your blog feed.
217-
218-
### Category
219-
220-
Each post can have `categories` attribute. It can be a string or an array. This
221-
will be displayed on index, archive and each post, and provide a link to the
222-
archive of category.
223-
224-
``` yaml
225-
layout: post
226-
title: Awesome Post
227-
categories: Misc
228-
```
229-
230-
``` yaml
231-
layout: post
232-
title: Another Awesome Post
233-
categories:
234-
- Misc
235-
- Idea
236-
```
237-
238-
### Tag
239-
240-
Each post can have `tags` attribute. It can be a string or an array. This will
241-
be displayed on index, archive and each post, and provide a link to the archive
242-
of tag.
243-
244-
``` yaml
245-
layout: post
246-
title: Awesome Post
247-
tags: food
248-
```
249-
250-
``` yaml
251-
layout: post
252-
title: Another Awesome Post
253-
tags:
254-
- food
255-
- trip
256-
```
257-
258-
### Feed
259-
260-
Create `<your-site>/feed.xml` with:
261-
262-
``` yaml
263-
---
264-
layout: feed
265-
---
266-
```
267-
268-
If you want to use another path for feed, you can specify a non-default path via
269-
your site's config.
270-
271-
``` yaml
272-
feed:
273-
path: atom.xml
274-
```
275-
276-
Then create `<your-site>/atom.xml` with the same content of `feed.xml` above.
277-
278-
### Comments
279-
280-
whiteglass provides the ability to include your favourite commenting service, like [Disqus](https://disqus.com) or [Isso](https://isso-comments.de/).
281-
282-
To enable comments on pages and posts:
283-
1. Overwrite the `_includes/custom_comments_provider.html` with your custom provider of comments.
284-
2. Add `comments: true` to your `_config.yml`.
285-
286-
To disable comments on certain pages or posts specify `comments: false` in the front matter of the page or post.
287-
288-
### Metadata for SEO
289-
290-
#### Keywords
291-
292-
Each post can have `keywords` attribute. This is a comma-separated list which is
293-
used in meta descriptions for improving SEO.
294-
295-
``` yaml
296-
layout: post
297-
title: How to configure jekyll-whiteglass
298-
keywords: jekyll, whiteglass, github pages
299-
```
300-
301-
YAML list is also available:
302-
303-
``` yaml
304-
keywords:
305-
- jekyll
306-
- whiteglass
307-
- github pages
308-
```
309-
310-
#### Twitter
311-
312-
- `site.twitter_username` sets `twitter:site` and `twitter:creator` meta tag
313-
- `site.twitter_image` sets `twitter:image:src` meta tag
314-
- `page.twitter_card.type` sets `twitter:card` meta tag (default: `summary`)
315-
- If `page.twitter_card.type` is `gallery`, it sets `twitter:image0`, `twitter:image1`, `twitter:image2` and `twitter:image3` meta tags with `page.twitter_card.image`, `page.twitter_card.image1`, `page.twitter_card.image2` and `page.twitter_card.image3`, respectively
316-
- If `page.twitter_card.type` is `photo`, `page.twitter_card.width` sets `twitter:image:width` meta tag and `page.twitter_card.height` sets `twitter:image:height` meta tag
317-
- `page.twitter_card.creator` sets `twitter:creator` meta tag. It overrides `site.twitter_username`
318-
- `page.twitter_card.image` sets `twitter:image:src` meta tag if `page.twitter_card.type` is not `gallery`. It overrides `site.twitter_image`
319-
320-
#### Facebook
321-
322-
- `site.facebook_app_id` sets `fb:admins` meta tag
323-
- `site.facebook_page` sets `article:author` meta tag
324-
- `site.facebook_image` sets `og:image` meta tag
325-
- `page.facebook.image` sets `og:image` meta tag. It overrides `site.facebook_image`
326-
327-
### Navigation
328-
329-
To define header links, add titles and URLs under the `main` key in
330-
`_data/navigation.yml`:
331-
332-
``` yaml
333-
main:
334-
- title: "About"
335-
url: /about/
336-
- title: "Archives"
337-
url: /archives/
338-
- title: "GitHub"
339-
url: https://github.com/yous/whiteglass
340-
```
341-
342-
### Enabling Google Analytics
343-
344-
To enable Google Analytics, add the following lines to your Jekyll site:
345-
346-
``` yaml
347-
google_analytics: UA-NNNNNNNN-N
348-
```
349-
350-
For Google Analytics 4, add the following lines:
351-
352-
``` yaml
353-
google_analytics: G-NNNNNNNNNN
354-
```
355-
356-
Replace `N`s with your specific ID.

0 commit comments

Comments
 (0)