Skip to content

Commit

Permalink
chore: reorder headings
Browse files Browse the repository at this point in the history
  • Loading branch information
ankitskvmdam committed Jun 12, 2022
1 parent 543fc3b commit 47e59ee
Showing 1 changed file with 40 additions and 40 deletions.
80 changes: 40 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,23 +251,23 @@ If the search feature is enabled, you'll see a `data` folder in the output. This

`options` can be any valid CodePen options. For more visit: [Codepen Prefill options](https://blog.codepen.io/documentation/prefill/#all-the-json-options-0)

### Add styles
### Add static dir

To create custom style rules. Example:
To include static files:

```json
"theme_opts" {
"create_style": ".sidebar-title { font-size: 2rem }"
"theme_opts": {
"static_dir": ["./static"],
}
```

### Add scripts
### Add styles

To create custom scripts. Example:
To create custom style rules. Example:

```json
"theme_opts": {
"add_scripts": "function foo(){console.log('foo')} function bar() {console.log('bar')}"
"theme_opts" {
"create_style": ".sidebar-title { font-size: 2rem }"
}
```

Expand All @@ -289,6 +289,30 @@ Example:
],
```

### Add custom css files

To include css files. Example:

```json
"theme_opts" {
"include_css": ["./static/index.css", "./src/docs/index.css"]
}
```

> Note: You are not required to manually copy file to output dir
It will include the css files to the output dir and also attach a link tag to the html pointing to the included css file.

### Add scripts

To create custom scripts. Example:

```json
"theme_opts": {
"add_scripts": "function foo(){console.log('foo')} function bar() {console.log('bar')}"
}
```

### Add script paths

Use this option to add third party js library. If you want to add your own custom script file then consider using [Add custom script files](#add-custom-script-files)
Expand All @@ -307,59 +331,35 @@ Example:
],
```

### Footer

```json
"theme_opts": {

"footer": "This is footer" // or <div class="footer-wrapper">This is a footer </div>
}
```

### Add static dir

To include static files:

```json
"theme_opts": {
"static_dir": ["./static"],
}
```

This will copy the static folder to the output dir.

> Note: If the directory doesn't exists then you may get an error. Also directory is relative to your jsdoc config file.
This will not flatten the directory it keep the directory structure as it is.

### Add custom css files
### Add custom script files

To include css files. Example:
To include js files. Example:

```json
"theme_opts" {
"include_css": ["./static/index.css", "./src/docs/index.css"]
"theme_opts": {
"include_js": ["./static/index.js", "./src/docs/index.js"]
}
```

> Note: You are not required to manually copy file to output dir
It will include the css files to the output dir and also attach a link tag to the html pointing to the included css file.

### Add custom script files
It will include the js files to the output dir and also attach a script tag to the html pointing to the included js file.

To include js files. Example:
### Footer

```json
"theme_opts": {
"include_js": ["./static/index.js", "./src/docs/index.js"]

"footer": "This is footer" // or <div class="footer-wrapper">This is a footer </div>
}
```

> Note: You are not required to manually copy file to output dir
It will include the js files to the output dir and also attach a script tag to the html pointing to the included js file.

### To exclude inherited

To exclude inherited symbols. Example:
Expand Down

0 comments on commit 47e59ee

Please sign in to comment.