Skip to content

Commit b457745

Browse files
Michael KechinovMichael Kechinov
Michael Kechinov
authored and
Michael Kechinov
committed
our content
1 parent 27624c1 commit b457745

File tree

9 files changed

+37
-555
lines changed

9 files changed

+37
-555
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ doc/
2525

2626
# Vagrant artifacts
2727
ubuntu-*-console.log
28+
.idea
29+
*.iml

CHANGELOG.md

+1-231
Original file line numberDiff line numberDiff line change
@@ -1,233 +1,3 @@
11
# Changelog
22

3-
## Version 2.7.0
4-
5-
*June 21, 2020*
6-
7-
* __[security]__ Bumped rack in Gemfile.lock from 2.2.2 to 2.2.3
8-
* Bumped bundled jQuery from 3.2.1 to 3.5.1
9-
* Bumped bundled lunr from 0.5.7 to 2.3.8
10-
* Bumped imagesloaded from 3.1.8 to 4.1.4
11-
* Bumped rouge from 3.17.0 to 3.20.0
12-
* Bumped redcarpet from 3.4.0 to 3.5.0
13-
* Fix color of highlighted code being unreadable when printing page
14-
* Add clipboard icon for "Copy to Clipboard" functionality to code boxes (see note below)
15-
* Fix handling of ToC selectors that contain punctutation (thanks @gruis)
16-
* Fix language bar truncating languages that overflow screen width
17-
* Strip HTML tags from ToC title before displaying it in title bar in JS (backup to stripping done in Ruby code) (thanks @atic)
18-
19-
To enable the new clipboard icon, you need to add `code_clipboard: true` to the frontmatter of source/index.html.md.
20-
See [this line](https://github.com/slatedocs/slate/blame/main/source/index.html.md#L19) for an example of usage.
21-
22-
## Version 2.6.1
23-
24-
*May 30, 2020*
25-
26-
* __[security]__ update child dependency activesupport in Gemfile.lock to 5.4.2.3
27-
* Update Middleman in Gemfile.lock to 4.3.7
28-
* Replace Travis-CI with GitHub actions for continuous integration
29-
* Replace Spectrum with GitHub discussions
30-
31-
## Version 2.6.0
32-
33-
*May 18, 2020*
34-
35-
__Note__: 2.5.0 was "pulled" due to a breaking bug discovered after release. It is recommended to skip it, and move straight to 2.6.0.
36-
37-
* Fix large whitespace gap in middle column for sections with codeblocks
38-
* Fix highlighted code elements having a different background than rest of code block
39-
* Change JSON keys to have a different font color than their values
40-
* Disable asset hashing for woff and woff2 elements due to middleman bug breaking woff2 asset hashing in general
41-
* Move Dockerfile to Debian from Alpine
42-
* Converted repo to a [GitHub template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)
43-
* Update sassc to 2.3.0 in Gemfile.lock
44-
45-
## Version 2.5.0
46-
47-
*May 8, 2020*
48-
49-
* __[security]__ update nokogiri to ~> 1.10.8
50-
* Update links in example docs to https://github.com/slatedocs/slate from https://github.com/lord/slate
51-
* Update LICENSE to include full Apache 2.0 text
52-
* Test slate against Ruby 2.5 and 2.6 on Travis-CI
53-
* Update Vagrantfile to use Ubuntu 18.04 (thanks @bradthurber)
54-
* Parse arguments and flags for deploy.sh on script start, instead of potentially after building source files
55-
* Install nodejs inside Vagrantfile (thanks @fernandoaguilar)
56-
* Add Dockerfile for running slate (thanks @redhatxl)
57-
* update middleman-syntax and rouge to ~>3.2
58-
* update middleman to 4.3.6
59-
60-
## Version 2.4.0
61-
62-
*October 19, 2019*
63-
64-
- Move repository from lord/slate to slatedocs/slate
65-
- 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)
66-
- Update `nokogiri` to 1.10.4
67-
- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack)
68-
- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack)
69-
- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jakemack](https://github.com/jakemack)
70-
- Add sass gem, thanks to [jakemack](https://github.com/jakemack)
71-
- Activate `asset_cache` in middleman to improve cacheability of static files, thanks to [Sam Gilman](https://github.com/thenengah)
72-
- Update to using bundler 2 for `Gemfile.lock`, thanks to [jakemack](https://github.com/jakemack)
73-
74-
## Version 2.3.1
75-
76-
*July 5, 2018*
77-
78-
- Update `sprockets` in `Gemfile.lock` to fix security warnings
79-
80-
## Version 2.3
81-
82-
*July 5, 2018*
83-
84-
- Allows strikethrough in markdown by default.
85-
- Upgrades jQuery to 3.2.1, thanks to [Tomi Takussaari](https://github.com/TomiTakussaari)
86-
- Fixes invalid HTML in `layout.erb`, thanks to [Eric Scouten](https://github.com/scouten) for pointing out
87-
- Hopefully fixes Vagrant memory issues, thanks to [Petter Blomberg](https://github.com/p-blomberg) for the suggestion
88-
- Cleans HTML in headers before setting `document.title`, thanks to [Dan Levy](https://github.com/justsml)
89-
- Allows trailing whitespace in markdown files, thanks to [Samuel Cousin](https://github.com/kuzyn)
90-
- Fixes pushState/replaceState problems with scrolling not changing the document hash, thanks to [Andrey Fedorov](https://github.com/anfedorov)
91-
- 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)
92-
- Fixes `nav-padding` bug, thanks [Jerome Dahdah](https://github.com/jdahdah)
93-
- Code style fixes thanks to [Sebastian Zaremba](https://github.com/vassyz)
94-
- Nokogiri version bump thanks to [Grey Baker](https://github.com/greysteil)
95-
- Fix to default `index.md` text thanks to [Nick Busey](https://github.com/NickBusey)
96-
97-
Thanks to everyone who contributed to this release!
98-
99-
## Version 2.2
100-
101-
*January 19, 2018*
102-
103-
- Fixes bugs with some non-roman languages not generating unique headers
104-
- Adds editorconfig, thanks to [Jay Thomas](https://github.com/jaythomas)
105-
- Adds optional `NestingUniqueHeadCounter`, thanks to [Vladimir Morozov](https://github.com/greenhost87)
106-
- 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)!
107-
- Adds links to Spectrum chat for questions in README and ISSUE_TEMPLATE
108-
109-
## Version 2.1
110-
111-
*October 30, 2017*
112-
113-
- Right-to-left text stylesheet option, thanks to [Mohammad Hossein Rabiee](https://github.com/mhrabiee)
114-
- Fix for HTML5 history state bug, thanks to [Zach Toolson](https://github.com/ztoolson)
115-
- 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)
116-
117-
Thanks to everyone who submitted PRs for this version!
118-
119-
## Version 2.0
120-
121-
*July 17, 2017*
122-
123-
- All-new statically generated table of contents
124-
- Should be much faster loading and scrolling for large pages
125-
- Smaller Javascript file sizes
126-
- Avoids the problem with the last link in the ToC not ever highlighting if the section was shorter than the page
127-
- Fixes control-click not opening in a new page
128-
- Automatically updates the HTML title as you scroll
129-
- Updated design
130-
- New default colors!
131-
- New spacings and sizes!
132-
- System-default typefaces, just like GitHub
133-
- Added search input delay on large corpuses to reduce lag
134-
- We even bumped the major version cause hey, why not?
135-
- Various small bug fixes
136-
137-
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.
138-
139-
## Version 1.5
140-
141-
*February 23, 2017*
142-
143-
- Add [multiple tabs per programming language](https://github.com/lord/slate/wiki/Multiple-language-tabs-per-programming-language) feature
144-
- Upgrade Middleman to add Ruby 1.4.0 compatibility
145-
- Switch default code highlighting color scheme to better highlight JSON
146-
- Various small typo and bug fixes
147-
148-
## Version 1.4
149-
150-
*November 24, 2016*
151-
152-
- Upgrade Middleman and Rouge gems, should hopefully solve a number of bugs
153-
- Update some links in README
154-
- Fix broken Vagrant startup script
155-
- Fix some problems with deploy.sh help message
156-
- Fix bug with language tabs not hiding properly if no error
157-
- Add `!default` to SASS variables
158-
- Fix bug with logo margin
159-
- Bump tested Ruby versions in .travis.yml
160-
161-
## Version 1.3.3
162-
163-
*June 11, 2016*
164-
165-
Documentation and example changes.
166-
167-
## Version 1.3.2
168-
169-
*February 3, 2016*
170-
171-
A small bugfix for slightly incorrect background colors on code samples in some cases.
172-
173-
## Version 1.3.1
174-
175-
*January 31, 2016*
176-
177-
A small bugfix for incorrect whitespace in code blocks.
178-
179-
## Version 1.3
180-
181-
*January 27, 2016*
182-
183-
We've upgraded Middleman and a number of other dependencies, which should fix quite a few bugs.
184-
185-
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.
186-
187-
## Version 1.2
188-
189-
*June 20, 2015*
190-
191-
**Fixes:**
192-
193-
- Remove crash on invalid languages
194-
- Update Tocify to scroll to the highlighted header in the Table of Contents
195-
- Fix variable leak and update search algorithms
196-
- Update Python examples to be valid Python
197-
- Update gems
198-
- More misc. bugfixes of Javascript errors
199-
- Add Dockerfile
200-
- Remove unused gems
201-
- Optimize images, fonts, and generated asset files
202-
- Add chinese font support
203-
- Remove RedCarpet header ID patch
204-
- Update language tabs to not disturb existing query strings
205-
206-
## Version 1.1
207-
208-
*July 27, 2014*
209-
210-
**Fixes:**
211-
212-
- Finally, a fix for the redcarpet upgrade bug
213-
214-
## Version 1.0
215-
216-
*July 2, 2014*
217-
218-
[View Issues](https://github.com/tripit/slate/issues?milestone=1&state=closed)
219-
220-
**Features:**
221-
222-
- Responsive designs for phones and tablets
223-
- Started tagging versions
224-
225-
**Fixes:**
226-
227-
- Fixed 'unrecognized expression' error
228-
- Fixed #undefined hash bug
229-
- Fixed bug where the current language tab would be unselected
230-
- Fixed bug where tocify wouldn't highlight the current section while searching
231-
- Fixed bug where ids of header tags would have special characters that caused problems
232-
- Updated layout so that pages with disabled search wouldn't load search.js
233-
- Cleaned up Javascript
3+
Empty, sorry.

CODE_OF_CONDUCT.md

-46
This file was deleted.

README.md

+9-85
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,12 @@
1-
<p align="center">
2-
<img src="https://raw.githubusercontent.com/slatedocs/img/main/logo-slate.png" alt="Slate: API Documentation Generator" width="226">
3-
<br>
4-
<a href="https://github.com/slatedocs/slate/actions?query=workflow%3ABuild+branch%3Amain"><img src="https://github.com/slatedocs/slate/workflows/Build/badge.svg?branch=main" alt="Build Status"></a>
5-
</p>
6-
7-
<p align="center">Slate helps you create beautiful, intelligent, responsive API documentation.</p>
8-
9-
<p align="center"><img src="https://raw.githubusercontent.com/slatedocs/img/main/screenshot-slate.png" width=700 alt="Screenshot of Example Documentation created with Slate"></p>
10-
11-
<p align="center"><em>The example above was created with Slate. Check it out at <a href="https://slatedocs.github.io/slate">slatedocs.github.io/slate</a>.</em></p>
12-
13-
Features
1+
REES46 API
142
------------
153

16-
* **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [PayPal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print.
17-
18-
* **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.
19-
20-
* **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks.
21-
22-
* **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with GitHub Flavored Markdown.
23-
24-
* **Out-of-the-box syntax highlighting** for [over 100 languages](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers), no configuration required.
25-
26-
* **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.
27-
28-
* **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public GitHub repository. Not only does this mean you get free hosting for your docs with GitHub Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.
29-
30-
* **RTL Support** Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc.
31-
32-
Getting started with Slate is super easy! Simply press the green "use this template" button above and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/).
33-
34-
Getting Started with Slate
35-
------------------------------
36-
37-
To get started with Slate, please check out the [Getting Started](https://github.com/slatedocs/slate/wiki#getting-started)
38-
section in our [wiki](https://github.com/slatedocs/slate/wiki).
39-
40-
We support running Slate in three different ways:
41-
* [Natively](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively)
42-
* [Using Vagrant](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Vagrant)
43-
* [Using Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker)
44-
45-
Companies Using Slate
46-
---------------------------------
47-
48-
* [NASA](https://api.nasa.gov)
49-
* [Sony](http://developers.cimediacloud.com)
50-
* [Best Buy](https://bestbuyapis.github.io/api-documentation/)
51-
* [Travis-CI](https://docs.travis-ci.com/api/)
52-
* [Greenhouse](https://developers.greenhouse.io/harvest.html)
53-
* [WooCommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/)
54-
* [Dwolla](https://docs.dwolla.com/)
55-
* [Clearbit](https://clearbit.com/docs)
56-
* [Coinbase](https://developers.coinbase.com/api)
57-
* [Parrot Drones](http://developer.parrot.com/docs/bebop/)
58-
* [Scale](https://docs.scaleapi.com/)
59-
60-
You can view more in [the list on the wiki](https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild).
61-
62-
Questions? Need Help? Found a bug?
63-
--------------------
64-
65-
If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Discussions tab](https://github.com/slatedocs/slate/discussions)!
66-
67-
Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch.
68-
69-
Contributors
70-
--------------------
71-
72-
Slate was built by [Robert Lord](https://lord.io) while at [TripIt](https://www.tripit.com/). The project is now maintained by [Matthew Peveler](https://github.com/MasterOdin) and [Mike Ralphson](https://github.com/MikeRalphson).
73-
74-
Thanks to the following people who have submitted major pull requests:
75-
76-
- [@chrissrogers](https://github.com/chrissrogers)
77-
- [@bootstraponline](https://github.com/bootstraponline)
78-
- [@realityking](https://github.com/realityking)
79-
- [@cvkef](https://github.com/cvkef)
80-
81-
Also, thanks to [Sauce Labs](http://saucelabs.com) for sponsoring the development of the responsive styles.
4+
* Tracks behavior
5+
* Recognize users
6+
* Recommends products
7+
* Search products
8+
* Send emails
9+
* Send web/mobile push
10+
* etc.
8211

83-
Special Thanks
84-
--------------------
85-
- [Middleman](https://github.com/middleman/middleman)
86-
- [middleman-syntax](https://github.com/middleman/middleman-syntax)
87-
- [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages)
88-
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
12+
Read the https://reference.api.rees46.com for usage details.

source/favicon.ico

14.7 KB
Binary file not shown.

source/images/logo.png

100644100755
14.3 KB
Loading

0 commit comments

Comments
 (0)