sanskrit-documentation-theme 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -23
- data/assets/css/navbar-toc.css +5 -5
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 853c30dc82b026e144b31afdcbe214c861b71dbea287a0f3c7e6552e39f7884c
|
4
|
+
data.tar.gz: 2c89782548d78824f88fc42fbe672ccb1f097ee9e7b1d8bbd2808042b1bf7f37
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 835a93194c1211297e0de2474b37e4e0b56acb96f94773d90ab5c08cc574ca8776c9a25d94071ef722e5098c344c7813d3ab959c1ca68bbf54cfb9257abd3d9a
|
7
|
+
data.tar.gz: 6b1d33905e2046f2c5db44fd98582f902090c8c84f774c6abeb6b9258ee1984e94755441e8250adc8fe833894e045d14193d0c55b9dd286ad8cca2ce6c75b9d1
|
data/README.md
CHANGED
@@ -20,42 +20,33 @@ Some notable things you get with this theme (in decreasing order of interest):
|
|
20
20
|
- the usual Jekyll blog.
|
21
21
|
- Post tag support
|
22
22
|
|
23
|
-
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
|
24
|
-
|
25
23
|
### Screenshots and examples
|
26
24
|
- See this test site: <https://sanskrit-coders.github.io/sanskrit-documentation-theme/>!
|
27
25
|
|
28
26
|
[![Screenshot 1](https://i.imgur.com/2ggUjKK.png)](https://i.imgur.com/2ggUjKK.png){:target="_blank"}
|
29
27
|
|
30
|
-
## Installation
|
31
|
-
### Direct method
|
32
|
-
- Add this line to your Jekyll site's `Gemfile`:
|
33
|
-
```ruby
|
34
|
-
gem "sanskrit-documentation-theme"
|
35
|
-
```
|
36
|
-
- And add this line to your Jekyll site's `_config.yml`:
|
37
|
-
```yaml
|
38
|
-
theme: sanskrit-documentation-theme
|
39
|
-
```
|
40
|
-
- And then execute `bundle` Or install it yourself as: `gem install sanskrit-documentation-theme`
|
41
|
-
|
42
|
-
### Remote theme method
|
43
|
-
- Add this line to your Jekyll site's `_config.yml`:
|
44
|
-
`remote_theme: sanskrit-coders/sanskrit-documentation-theme`
|
45
|
-
|
46
28
|
## Usage
|
29
|
+
Take a look at this very repository for an example!
|
47
30
|
|
48
|
-
|
31
|
+
In particular, note the files that you would need to add / modify as needed:
|
49
32
|
- the `_config.yml` file.
|
50
|
-
-
|
33
|
+
- Especially, specify that you're using this theme by either adding `remote_theme: sanskrit-coders/sanskrit-documentation-theme` or `theme: sanskrit-documentation-theme` (In which case you'd need to install the theme gem).
|
34
|
+
- The _data/sidebars/*.yml file, which defines the contents of the sidebar and top navigation menu you see for each page.
|
51
35
|
- The 404.md file, which defines how the "Page Not Found" results look like.
|
52
|
-
- Gemfile
|
36
|
+
- The Gemfile : no modification needed.
|
53
37
|
|
54
|
-
###
|
55
|
-
-
|
38
|
+
### Installation
|
39
|
+
PS: Installation is not needed if you are using the 'remote-theme' method described above.
|
56
40
|
|
41
|
+
Steps:
|
42
|
+
- Add this line to your Jekyll site's `Gemfile`: `gem "sanskrit-documentation-theme"`
|
43
|
+
- Execute `bundle` Or install it yourself as: `gem install sanskrit-documentation-theme`
|
44
|
+
|
45
|
+
### Search / webmaster tips
|
46
|
+
- sitemap.xml can be explicitly submitted to various search engines.
|
57
47
|
|
58
48
|
## Contributing
|
49
|
+
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
|
59
50
|
|
60
51
|
Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
61
52
|
|
data/assets/css/navbar-toc.css
CHANGED
@@ -43,11 +43,11 @@ li.dropdownActive a {
|
|
43
43
|
/************************************************************/
|
44
44
|
/* FAQ page */
|
45
45
|
#accordion .panel-heading {
|
46
|
-
font-size:
|
46
|
+
font-size: 18px;
|
47
47
|
}
|
48
48
|
|
49
49
|
a.accordion-toggle, a.accordion-collapsed {
|
50
|
-
font-size:
|
50
|
+
font-size: 18px;
|
51
51
|
text-decoration: none;
|
52
52
|
}
|
53
53
|
/************************************************************/
|
@@ -111,14 +111,14 @@ a.accordion-toggle, a.accordion-collapsed {
|
|
111
111
|
}
|
112
112
|
|
113
113
|
.nav li a {
|
114
|
-
font-size:
|
115
|
-
line-height:
|
114
|
+
font-size: 18px;
|
115
|
+
line-height: 20px;
|
116
116
|
padding: 2px 10px;
|
117
117
|
background-color: #f1f1f1;
|
118
118
|
}
|
119
119
|
|
120
120
|
.nav > li > a {
|
121
|
-
font-size:
|
121
|
+
font-size: 18px;
|
122
122
|
line-height: 20px;
|
123
123
|
padding: 4px 10px;
|
124
124
|
}
|