Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions .jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,26 @@
],
"excludePattern": "(node_modules/|jsdocs)"
},
"templates": {
"cleverLinks": false,
"monospaceLinks": true
},
"opts": {
"template": "docdash-template",
"destination": "./jsdocs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/docdash",
"sort": false
},
"templates":
{
"cleverLinks": false,
"monospaceLinks": true,
"default":
{
"staticFiles":
{
"include": [ "./docdash-template/favicon.ico"]
}
}
},
"docdash": {
"static": true,
"sort": false
Expand Down
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Changelog

## [v1.1.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.1.0) (2020-10-23)
- Bug Fix
- Owner of organization can access stack function

## [v1.0.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.0.0) (2020-09-23)
- Initial release for Contentstack CMA base JS management SDK
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ contentstackClient.login({ email: 'EMAIL', password: 'PASSWORD'})
### Management Token
[Management Tokens](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens/) are **stack-level** tokens, with no users attached to them.
```
contentstackClient.stack({ api_key: 'API_KEY', management_token: 'MANAGEMENT_TOKEN' })
contentstackClient.stack({ api_key: 'API_KEY', management_token: 'MANAGEMENT_TOKEN' }).contentType('CONTENT_TYPE_UID')
.fetch()
.then((stack) => {
console.log(stack)
.then((contenttype) => {
console.log(contenttype)
})
```
### Contentstack Management JavaScript SDK: 5-minute Quickstart
Expand Down
15 changes: 15 additions & 0 deletions docdash-template/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
node_modules
fixtures-doc
*.sublime-project
*.sublime-workspace
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
logs
*.log
jspm_packages
.npm
20 changes: 20 additions & 0 deletions docdash-template/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
language: node_js
node_js:
- '8'
- '10'
sudo: false
branches:
except:
- gh-pages
before_script:
- npm install
- npm install -g jsdoc
script:
- npm test
after_success:
- cd $TRAVIS_BUILD_DIR
- chmod +x generateDocs.sh
- bash generateDocs.sh
env:
global:
secure: SVc8CMwRHndoJpYUzfmmbj4mb0uvhTYFbQMqB2GNjKT9yFv5OpryNn7Yne16PD/MJ5zEtJ+QNuOYnQG+GDecTC5Ok9xKycgZyN7HA2+C6yE1u5C4o33XVTliW0aT7ADYra1V3jmP794SJSHALCwosJHAGxG6AH9cY/s4xfCuFE1TbwUOZA8WAxsu2tLvEp7IdoXLG3XGqwirSL95iC9VdfNcoF1uXdiJu1ZJw8/3RJUxQR6oDjQLsiv6rag83ktd0+Oe+nKw8qi4r1vRH6+SfZaEcaCy7qtZbNcwsE0CCZ3gwM3ekbrdnOMlOqz/Kgh7iTBlkfDpw6pVc3zaL9oagAbVJdbNiRWto8ourzaa4uAbqZJrJCl2auKRHLZTssu+jg7XI+oPhNsndhJZRDG0EvvDrbbSlVgCkTkgoucEcK/4HOt5b1m+5sd8343hDYBC4+26mhc5gzvojOQgVu+W+qgPMFf9Xt5LTTdPsKdNRPICFUy0h6R2FVfHmOYv2T42nm4I2NWXnpQffWsq2zHIuEiz0sBGDk27z7lzHwWnumJ98gPdYfGqSpWXzRPUoK80Jz/YIMop3yeiSY9GCHk9Lt8F548xQRhqQCzjmHo9wSmubfE5LHQCehxZ0zWrXzuLsxOWDh9NpKmM8dk5VV3ZBvqrMubNSBgpYp1YnGHFuRU=
65 changes: 65 additions & 0 deletions docdash-template/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## Version 1.2.0

* [feature] host fonts locally
* [feature] separate styles for headers inside user markdown
* [feature] hide static/private method depending of the config
* [fix] fix empty source code lines in some browsers
* [fix] improved viewing theme on smaller screens

## Version 1.1.1

* [feature] scroll to currently opened method on page load
* [fix] fixed searching in IE11
* [fix] hiding/showing find exact match to open only single relevant section

## Version 1.1.0

* [scripts] remove jQuery as dependency
* [feature] allow aliasing event names

## Version 1.0.3

* [style] break headers into multiple lines
* [style] break links in descriptions into multiple lines
* [fix] fix ancestor check when there are none, like including tutorials
* [fix] remove unnecessary files from published package
* [fix] stop crashing on incorrect params JSDoc comments
* [feature] add displaying version from package.json when it is provided
* [feature] add support for yield
* [feature] add support for namepsaces that are functions
* [feature] add support for interfaces
* [feature] add support for modifies

## Version 1.0.2

* [styles] increase space between custom menu items
* [option] Added `wrap` option to wrap long names instead of trimming them
* [option] Added `navLevel` option to control depth level to show in navbar, starting at 0
* [option] Added `private` option to show/hide @private in navbar

## Version 1.0.1

* Allow adding custom menu items
* Remove line-height: 160%

## Version 1.0.0

* Add option to add disqus comments to each page
* Add option to filter through navigation items
* Add option to have menus collapsed by default and only open the one for the current page
* Add option to provide custom site title
* Add option to provide meta information for the website
* Add option to provide opengraph information for the website
* Add viewport meta data
* Added global table styles
* Added support for @hidecontainer (jsdoc 3.5.0)
* Added support for useLongnameInNav
* Allow including typedefs in the menu
* Allow inclusion of custom CSS
* Allow injecting external or local copied scripts into HTML
* Allow removing single and double quotes from pathnames
* Fix crash when @example is empty or undefined
* Fix issue with node 8.5
* Fixing copyFile problem on some systems or nodejs versions
* Removes arbitrary width property
* Support ordering of the main navbar sections
61 changes: 61 additions & 0 deletions docdash-template/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# License

Docdash is free software, licensed under the Apache License, Version 2.0 (the
"License"). Commercial and non-commercial use are permitted in compliance with
the License.

Copyright (c) 2016 Clement Moron <clenemt@gmail.com> and the
[contributors to docdash](https://github.com/clenemt/docdash/graphs/contributors).
All rights reserved.

You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0

In addition, a copy of the License is included with this distribution.

As stated in Section 7, "Disclaimer of Warranty," of the License:

> Licensor provides the Work (and each Contributor provides its Contributions)
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
> express or implied, including, without limitation, any warranties or
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
> PARTICULAR PURPOSE. You are solely responsible for determining the
> appropriateness of using or redistributing the Work and assume any risks
> associated with Your exercise of permissions under this License.

The source code for docdash is available at:
https://github.com/clenemt/docdash

# Third-Party Software

Docdash includes or depends upon the following third-party software, either in
whole or in part. Each third-party software package is provided under its own
license.

## JSDoc 3

JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
"License"). Commercial and non-commercial use are permitted in compliance with
the License.

Copyright (c) 2011-2016 Michael Mathews <micmath@gmail.com> and the
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
All rights reserved.

You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0

In addition, a copy of the License is included with this distribution.

As stated in Section 7, "Disclaimer of Warranty," of the License:

> Licensor provides the Work (and each Contributor provides its Contributions)
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
> express or implied, including, without limitation, any warranties or
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
> PARTICULAR PURPOSE. You are solely responsible for determining the
> appropriateness of using or redistributing the Work and assume any risks
> associated with Your exercise of permissions under this License.

The source code for JSDoc 3 is available at:
https://github.com/jsdoc3/jsdoc
150 changes: 150 additions & 0 deletions docdash-template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
# Docdash
[![Build Status](https://api.travis-ci.org/clenemt/docdash.png?branch=master)](https://travis-ci.org/clenemt/docdash) [![npm version](https://badge.fury.io/js/docdash.svg)](https://badge.fury.io/js/docdash) [![license](https://img.shields.io/npm/l/docdash.svg)](LICENSE.md)

A clean, responsive documentation template theme for JSDoc 3.

![docdash-screenshot](https://cloud.githubusercontent.com/assets/447956/13398144/4dde7f36-defd-11e5-8909-1a9013302cb9.png)

![docdash-screenshot-2](https://cloud.githubusercontent.com/assets/447956/13401057/e30effd8-df0a-11e5-9f51-66257ac38e94.jpg)

## Example
See http://clenemt.github.io/docdash/ for a sample demo. :rocket:

## Install

```bash
$ npm install docdash
```

## Usage
Clone repository to your designated `jsdoc` template directory, then:

```bash
$ jsdoc entry-file.js -t path/to/docdash
```

## Usage (npm)
In your projects `package.json` file add a new script:

```json
"script": {
"generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
```

In your `jsdoc.json` file, add a template option.

```json
"opts": {
"template": "node_modules/docdash"
}
```

## Sample `jsdoc.json`
See the config file for the [fixtures](fixtures/fixtures.conf.json) or the sample below.

```json
{
"tags": {
"allowUnknownTags": false
},
"source": {
"include": "../js",
"includePattern": "\\.js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"opts": {
"template": "assets/template/docdash/",
"encoding": "utf8",
"destination": "docs/",
"recurse": true,
"verbose": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
```

## Options
Docdash supports the following options:

```json5
{
"docdash": {
"static": [false|true], // Display the static members inside the navbar
"sort": [false|true], // Sort the methods in the navbar
"sectionOrder": [ // Order the main section in the navbar (default order shown here)
"Classes",
"Modules",
"Externals",
"Events",
"Namespaces",
"Mixins",
"Tutorials",
"Interfaces"
],
"disqus": "", // Shortname for your disqus (subdomain during site creation)
"openGraph": { // Open Graph options (mostly for Facebook and other sites to easily extract meta information)
"title": "", // Title of the website
"type": "website", // Type of the website
"image": "", // Main image/logo
"site_name": "", // Site name
"url": "" // Main canonical URL for the main page of the site
},
"meta": { // Meta information options (mostly for search engines that have not indexed your site yet)
"title": "", // Also will be used as postfix to actualy page title, prefixed with object/document name
"description": "", // Description of overal contents of your website
"keyword": "" // Keywords for search engines
},
"search": [false|true], // Display seach box above navigation which allows to search/filter navigation items
"collapse": [false|true], // Collapse navigation by default except current object's navigation of the current page
"wrap": [false|true], // Wrap long navigation names instead of trimming them
"typedefs": [false|true], // Include typedefs in menu
"navLevel": [integer], // depth level to show in navbar, starting at 0 (false or -1 to disable)
"private": [false|true], // set to false to not show @private in navbar
"removeQuotes": [none|all|trim],// Remove single and double quotes, trim removes only surrounding ones
"scripts": [], // Array of external (or relative local copied using templates.default.staticFiles.include) js or css files to inject into HTML,
"menu": { // Adding additional menu items after Home
"Project Website": { // Menu item name
"href":"https://myproject.com", //the rest of HTML properties to add to manu item
"target":"_blank",
"class":"menu-item",
"id":"website_link"
},
"Forum": {
"href":"https://myproject.com.forum",
"target":"_blank",
"class":"menu-item",
"id":"forum_link"
}
},
scopeInOutputPath: [false|true], // Add scope from package file (if present) to the output path, true by default.
nameInOutputPath: [false|true], // Add name from package file to the output path, true by default.
versionInOutputPath: [false|true] // Add package version to the output path, true by default.
}
}
```

Place them anywhere inside your `jsdoc.json` file.

## Contributors

[![0](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/0)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/0)
[![1](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/1)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/1)
[![2](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/2)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/2)
[![3](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/3)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/3)
[![4](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/4)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/4)
[![5](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/5)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/5)
[![6](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/6)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/6)
[![7](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/images/7)](https://sourcerer.io/fame/ar2rsawseen/clenemt/docdash/links/7)

## Thanks
Thanks to [lodash](https://lodash.com) and [minami](https://github.com/nijikokun/minami).

## License
Licensed under the Apache License, version 2.0. (see [Apache-2.0](LICENSE.md)).
Binary file added docdash-template/favicon.ico
Binary file not shown.
Loading