Compare commits

..

9 Commits

Author SHA1 Message Date
Robert Wallach
4387864c5a Update runtime.md 2018-04-03 11:30:09 -05:00
Tom Pytleski
7e62571fc6 - make requested changes 2018-04-02 16:48:06 -05:00
Tom Pytleski
09addb857a - Finished prism runtime article
- made requested changes
2018-04-02 14:42:07 -05:00
Tom Pytleski
0d53fa58f4 Merge branch 'develop' into articles/prism/runtime.md
* develop: (248 commits)
  Update export-files.md
  Update export-files.md
  Create export-files.md
  Add files via upload
  Delete editor-export-files.gif
  Add files via upload
  Rename import-files to import-files.md
  Create import-files
  Add files via upload
  Add files via upload
  Update themes.md
  Add files via upload
  Delete design.png
  Delete validation.md
  Update hubs-introduction.md
  Update publishing.md
  Update routing.md
  Add files via upload
  Update transfer-ownership.md
  Update remove-people.md
  ...
2018-04-02 14:41:39 -05:00
Tom Pytleski
b41582782f - added some more function definitions
- made some requested changes
- updated header links
2018-03-19 16:52:03 -05:00
Tom Pytleski
62c83a8ed9 - converted to jsdocs, polish incoming. 2018-03-19 15:57:23 -05:00
Tom Pytleski
3502469fb7 - more jsdocs 2018-03-19 12:29:45 -05:00
Tom Pytleski
2ff2b19c07 - updating to jsdoc format 2018-03-19 11:18:04 -05:00
Tom Pytleski
a41ac20aca - javascript runtime reference, re wrote it. 2018-03-16 16:43:31 -05:00
7 changed files with 5 additions and 94 deletions

View File

@@ -1,46 +0,0 @@
# Custom CSS
![Applying Custom CSS](https://github.com/stoplightio/docs/blob/develop/assets/gifs/hubs-custom-css.gif?raw=true)
## What
Want to add some style and flair to your documentation? Add your own custom CSS to enhance your Hubs look and feel. Below are some of the classes you can modify:
```
.Hub
.HubHeader
.HubHeader-section
.HubHeaderItem.is-active
.HubHeaderItem-name
.HubMain
.HubSidebar-overlay
.HubSidebar-wrapper
.HubSidebar
.HubSidebar-inner
.HubBranding
.HubPage-wrapper
.HubPage
.HubPage-inner
.HubPage-content
.HubPageCrumbs
.HubPageCrumb
.HubPageBody
.HubBlock
.HubPageFooter
```
## How
1. Select the Hub you wish to modify
2. Select the **Design View**
3. Click on **Theme** in the top toolbar
4. Select **Custom CSS** in the bottom left
5. Input CSS in the text area at the bottom of the page
6. Input CSS in the generated **theme** file (optional)
7. In publishing, check the **Custom CSS** box under **Advanced** to apply the Custom CSS to that Hub when published
>After accessing Custom CSS, a **theme** file will be generated under Documentation in the file explorer. After making changes to your CSS, make sure to save the **theme** file.
---
**Related Articles**
- [Theming](/documentation/design/theming)

View File

@@ -21,13 +21,10 @@ Texture applies a texture to your header.
## How
1. Select the **Hub** you wish to modify
2. Select the **Design View**
3. Click on **Theme** at the top of the screen
4. Select a pre-selected color or choose your own color with the eyedropper
5. Select a texture
---
**Related Links**
- [Custom CSS](/documentation/design/custom-css)
3. Click on **Settings** at the top of the screen
4. Select **Theme** in the sidebar
5. Select a pre-selected color or choose your own color with the eyedropper
6. Select a texture

View File

@@ -1,40 +0,0 @@
# Variables in Hubs
## What
Inputting variables in API documentation whenever you consume them can quickly become a tedious time sink. The same pain point applies to people consuming your documentation. Inputting an API key everytime you want to send HTTP Requests to test endpoints is time better spent elsewhere. Stoplight removes this obstacle by storing variables in your local browser. Once you input a variable, it populates the rest of your docs, no duplication, no problems.
## How
You can specify variables in your docs by adding them at the specification level or directly into Hubs.
### Modeling Method
![Security Scheme in Specification](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-variables-modeling.png?raw=true)
1. Select the modeling file you wish to modify
2. Create a new **security scheme**
1. Input a **key** (required, must be unique in this specification)
2. Select a **type** of security scheme
3. Select a location for the security scheme under **in**
4. Input a **name**
3. Reference the specification in your Hub
---
### Hubs Method
![Adding variables to HTTP Request Maker](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-variables-tryitout.png?raw=true)
1. Select the Hub you wish to modify
2. Create a **HTTP Request Maker** block
3. Select the **Headers** tab
4. Click **Add Header**
5. Input a **header name**
6. Input a **header value**
***
**Related**
* [Security Schemes Overview](/modeling/modeling-with-openapi/security-schemes)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.0 MiB

After

Width:  |  Height:  |  Size: 2.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.7 KiB