Skip to content
This repository was archived by the owner on Aug 3, 2022. It is now read-only.

Commit 9f75690

Browse files
anshajgoelanshajgoel
committed
New docs
1 parent 957afe6 commit 9f75690

File tree

146 files changed

+11123
-10446
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+11123
-10446
lines changed

‎CHANGELOG.md

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Changelog
2+
3+
## Version 2.4.0
4+
5+
*October 19, 2019*
6+
7+
- Move repository from lord/slate to slatedocs/slate
8+
- Fix documentation to point at new repo link, thanks to [Arun](https://github.com/slash-arun), [Gustavo Gawryszewski](https://github.com/gawry), and [Daniel Korbit](https://github.com/danielkorbit)
9+
- Update `nokogiri` to 1.10.4
10+
- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack)
11+
- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack)
12+
- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jackmack](https://github.com/jakemack)
13+
- Add sass gem, thanks to [jackmack](https://github.com/jackmack)
14+
- Activate `asset_cache` in middleman to improve cacheability of static files, thanks to [Sam Gilman](https://github.com/thenengah)
15+
- Update to using bundler 2 for `Gemfile.lock`, thanks to [jackmack](https://github.com/jakemack)
16+
17+
## Version 2.3.1
18+
19+
*July 5, 2018*
20+
21+
- Update `sprockets` in `Gemfile.lock` to fix security warnings
22+
23+
## Version 2.3
24+
25+
*July 5, 2018*
26+
27+
- Allows strikethrough in markdown by default.
28+
- Upgrades jQuery to 3.2.1, thanks to [Tomi Takussaari](https://github.com/TomiTakussaari)
29+
- Fixes invalid HTML in `layout.erb`, thanks to [Eric Scouten](https://github.com/scouten) for pointing out
30+
- Hopefully fixes Vagrant memory issues, thanks to [Petter Blomberg](https://github.com/p-blomberg) for the suggestion
31+
- Cleans HTML in headers before setting `document.title`, thanks to [Dan Levy](https://github.com/justsml)
32+
- Allows trailing whitespace in markdown files, thanks to [Samuel Cousin](https://github.com/kuzyn)
33+
- Fixes pushState/replaceState problems with scrolling not changing the document hash, thanks to [Andrey Fedorov](https://github.com/anfedorov)
34+
- Removes some outdated examples, thanks [@al-tr](https://github.com/al-tr), [Jerome Dahdah](https://github.com/jdahdah), and [Ricardo Castro](https://github.com/mccricardo)
35+
- Fixes `nav-padding` bug, thanks [Jerome Dahdah](https://github.com/jdahdah)
36+
- Code style fixes thanks to [Sebastian Zaremba](https://github.com/vassyz)
37+
- Nokogiri version bump thanks to [Grey Baker](https://github.com/greysteil)
38+
- Fix to default `index.md` text thanks to [Nick Busey](https://github.com/NickBusey)
39+
40+
Thanks to everyone who contributed to this release!
41+
42+
## Version 2.2
43+
44+
*January 19, 2018*
45+
46+
- Fixes bugs with some non-roman languages not generating unique headers
47+
- Adds editorconfig, thanks to [Jay Thomas](https://github.com/jaythomas)
48+
- Adds optional `NestingUniqueHeadCounter`, thanks to [Vladimir Morozov](https://github.com/greenhost87)
49+
- Small fixes to typos and language, thx [Emir Ribić](https://github.com/ribice), [Gregor Martynus](https://github.com/gr2m), and [Martius](https://github.com/martiuslim)!
50+
- Adds links to Spectrum chat for questions in README and ISSUE_TEMPLATE
51+
52+
## Version 2.1
53+
54+
*October 30, 2017*
55+
56+
- Right-to-left text stylesheet option, thanks to [Mohammad Hossein Rabiee](https://github.com/mhrabiee)
57+
- Fix for HTML5 history state bug, thanks to [Zach Toolson](https://github.com/ztoolson)
58+
- Small styling changes, typo fixes, small bug fixes from [Marian Friedmann](https://github.com/rnarian), [Ben Wilhelm](https://github.com/benwilhelm), [Fouad Matin](https://github.com/fouad), [Nicolas Bonduel](https://github.com/NicolasBonduel), [Christian Oliff](https://github.com/coliff)
59+
60+
Thanks to everyone who submitted PRs for this version!
61+
62+
## Version 2.0
63+
64+
*July 17, 2017*
65+
66+
- All-new statically generated table of contents
67+
- Should be much faster loading and scrolling for large pages
68+
- Smaller Javascript file sizes
69+
- Avoids the problem with the last link in the ToC not ever highlighting if the section was shorter than the page
70+
- Fixes control-click not opening in a new page
71+
- Automatically updates the HTML title as you scroll
72+
- Updated design
73+
- New default colors!
74+
- New spacings and sizes!
75+
- System-default typefaces, just like GitHub
76+
- Added search input delay on large corpuses to reduce lag
77+
- We even bumped the major version cause hey, why not?
78+
- Various small bug fixes
79+
80+
Thanks to everyone who helped debug or wrote code for this version! It was a serious community effort, and I couldn't have done it alone.
81+
82+
## Version 1.5
83+
84+
*February 23, 2017*
85+
86+
- Add [multiple tabs per programming language](https://github.com/lord/slate/wiki/Multiple-language-tabs-per-programming-language) feature
87+
- Upgrade Middleman to add Ruby 1.4.0 compatibility
88+
- Switch default code highlighting color scheme to better highlight JSON
89+
- Various small typo and bug fixes
90+
91+
## Version 1.4
92+
93+
*November 24, 2016*
94+
95+
- Upgrade Middleman and Rouge gems, should hopefully solve a number of bugs
96+
- Update some links in README
97+
- Fix broken Vagrant startup script
98+
- Fix some problems with deploy.sh help message
99+
- Fix bug with language tabs not hiding properly if no error
100+
- Add `!default` to SASS variables
101+
- Fix bug with logo margin
102+
- Bump tested Ruby versions in .travis.yml
103+
104+
## Version 1.3.3
105+
106+
*June 11, 2016*
107+
108+
Documentation and example changes.
109+
110+
## Version 1.3.2
111+
112+
*February 3, 2016*
113+
114+
A small bugfix for slightly incorrect background colors on code samples in some cases.
115+
116+
## Version 1.3.1
117+
118+
*January 31, 2016*
119+
120+
A small bugfix for incorrect whitespace in code blocks.
121+
122+
## Version 1.3
123+
124+
*January 27, 2016*
125+
126+
We've upgraded Middleman and a number of other dependencies, which should fix quite a few bugs.
127+
128+
Instead of `rake build` and `rake deploy`, you should now run `bundle exec middleman build --clean` to build your server, and `./deploy.sh` to deploy it to Github Pages.
129+
130+
## Version 1.2
131+
132+
*June 20, 2015*
133+
134+
**Fixes:**
135+
136+
- Remove crash on invalid languages
137+
- Update Tocify to scroll to the highlighted header in the Table of Contents
138+
- Fix variable leak and update search algorithms
139+
- Update Python examples to be valid Python
140+
- Update gems
141+
- More misc. bugfixes of Javascript errors
142+
- Add Dockerfile
143+
- Remove unused gems
144+
- Optimize images, fonts, and generated asset files
145+
- Add chinese font support
146+
- Remove RedCarpet header ID patch
147+
- Update language tabs to not disturb existing query strings
148+
149+
## Version 1.1
150+
151+
*July 27, 2014*
152+
153+
**Fixes:**
154+
155+
- Finally, a fix for the redcarpet upgrade bug
156+
157+
## Version 1.0
158+
159+
*July 2, 2014*
160+
161+
[View Issues](https://github.com/tripit/slate/issues?milestone=1&state=closed)
162+
163+
**Features:**
164+
165+
- Responsive designs for phones and tablets
166+
- Started tagging versions
167+
168+
**Fixes:**
169+
170+
- Fixed 'unrecognized expression' error
171+
- Fixed #undefined hash bug
172+
- Fixed bug where the current language tab would be unselected
173+
- Fixed bug where tocify wouldn't highlight the current section while searching
174+
- Fixed bug where ids of header tags would have special characters that caused problems
175+
- Updated layout so that pages with disabled search wouldn't load search.js
176+
- Cleaned up Javascript

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎Gemfile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
ruby '>=2.3.1'
2+
source 'https://rubygems.org'
3+
4+
# Middleman
5+
gem 'middleman', '~>4.3'
6+
gem 'middleman-syntax', '~> 3.0'
7+
gem 'middleman-autoprefixer', '~> 2.7'
8+
gem 'middleman-sprockets', '~> 4.1'
9+
gem 'rouge', '~> 2.0.5'
10+
gem 'redcarpet', '~> 3.4.0'
11+
gem 'nokogiri', '~> 1.10.4'
12+
gem 'sass'

‎Gemfile.lock

+136
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (5.0.7.2)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
addressable (2.6.0)
10+
public_suffix (>= 2.0.2, < 4.0)
11+
autoprefixer-rails (9.5.1.1)
12+
execjs
13+
backports (3.15.0)
14+
coffee-script (2.4.1)
15+
coffee-script-source
16+
execjs
17+
coffee-script-source (1.12.2)
18+
concurrent-ruby (1.1.5)
19+
contracts (0.13.0)
20+
dotenv (2.7.2)
21+
erubis (2.7.0)
22+
execjs (2.7.0)
23+
fast_blank (1.0.0)
24+
fastimage (2.1.5)
25+
ffi (1.11.1)
26+
haml (5.1.1)
27+
temple (>= 0.8.0)
28+
tilt
29+
hamster (3.0.0)
30+
concurrent-ruby (~> 1.0)
31+
hashie (3.6.0)
32+
i18n (0.9.5)
33+
concurrent-ruby (~> 1.0)
34+
kramdown (1.17.0)
35+
listen (3.0.8)
36+
rb-fsevent (~> 0.9, >= 0.9.4)
37+
rb-inotify (~> 0.9, >= 0.9.7)
38+
memoist (0.16.0)
39+
middleman (4.3.4)
40+
coffee-script (~> 2.2)
41+
haml (>= 4.0.5)
42+
kramdown (~> 1.2)
43+
middleman-cli (= 4.3.4)
44+
middleman-core (= 4.3.4)
45+
middleman-autoprefixer (2.10.1)
46+
autoprefixer-rails (~> 9.1)
47+
middleman-core (>= 3.3.3)
48+
middleman-cli (4.3.4)
49+
thor (>= 0.17.0, < 2.0)
50+
middleman-core (4.3.4)
51+
activesupport (>= 4.2, < 5.1)
52+
addressable (~> 2.3)
53+
backports (~> 3.6)
54+
bundler
55+
contracts (~> 0.13.0)
56+
dotenv
57+
erubis
58+
execjs (~> 2.0)
59+
fast_blank
60+
fastimage (~> 2.0)
61+
hamster (~> 3.0)
62+
hashie (~> 3.4)
63+
i18n (~> 0.9.0)
64+
listen (~> 3.0.0)
65+
memoist (~> 0.14)
66+
padrino-helpers (~> 0.13.0)
67+
parallel
68+
rack (>= 1.4.5, < 3)
69+
sassc (~> 2.0)
70+
servolux
71+
tilt (~> 2.0.9)
72+
uglifier (~> 3.0)
73+
middleman-sprockets (4.1.1)
74+
middleman-core (~> 4.0)
75+
sprockets (>= 3.0)
76+
middleman-syntax (3.0.0)
77+
middleman-core (>= 3.2)
78+
rouge (~> 2.0)
79+
mini_portile2 (2.4.0)
80+
minitest (5.11.3)
81+
nokogiri (1.10.4)
82+
mini_portile2 (~> 2.4.0)
83+
padrino-helpers (0.13.3.4)
84+
i18n (~> 0.6, >= 0.6.7)
85+
padrino-support (= 0.13.3.4)
86+
tilt (>= 1.4.1, < 3)
87+
padrino-support (0.13.3.4)
88+
activesupport (>= 3.1)
89+
parallel (1.17.0)
90+
public_suffix (3.1.0)
91+
rack (2.0.7)
92+
rake (12.3.2)
93+
rb-fsevent (0.10.3)
94+
rb-inotify (0.10.0)
95+
ffi (~> 1.0)
96+
redcarpet (3.4.0)
97+
rouge (2.0.7)
98+
sass (3.7.4)
99+
sass-listen (~> 4.0.0)
100+
sass-listen (4.0.0)
101+
rb-fsevent (~> 0.9, >= 0.9.4)
102+
rb-inotify (~> 0.9, >= 0.9.7)
103+
sassc (2.0.1)
104+
ffi (~> 1.9)
105+
rake
106+
servolux (0.13.0)
107+
sprockets (3.7.2)
108+
concurrent-ruby (~> 1.0)
109+
rack (> 1, < 3)
110+
temple (0.8.1)
111+
thor (0.20.3)
112+
thread_safe (0.3.6)
113+
tilt (2.0.9)
114+
tzinfo (1.2.5)
115+
thread_safe (~> 0.1)
116+
uglifier (3.2.0)
117+
execjs (>= 0.3.0, < 3)
118+
119+
PLATFORMS
120+
ruby
121+
122+
DEPENDENCIES
123+
middleman (~> 4.3)
124+
middleman-autoprefixer (~> 2.7)
125+
middleman-sprockets (~> 4.1)
126+
middleman-syntax (~> 3.0)
127+
nokogiri (~> 1.10.4)
128+
redcarpet (~> 3.4.0)
129+
rouge (~> 2.0.5)
130+
sass
131+
132+
RUBY VERSION
133+
ruby 2.3.3p222
134+
135+
BUNDLED WITH
136+
2.0.2

0 commit comments

Comments
 (0)