mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-31 18:49:43 +08:00
chore(docs): moving docs from /docs/v2/native
to /docs/native
This commit is contained in:
parent
947bf227d0
commit
47b593b43d
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@ -4,7 +4,7 @@
|
|||||||
#### There are no rules, but here are a few things to consider:
|
#### There are no rules, but here are a few things to consider:
|
||||||
###### Before you submit an issue:
|
###### Before you submit an issue:
|
||||||
* Do a quick search to see if there are similar issues
|
* Do a quick search to see if there are similar issues
|
||||||
* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic 2, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/v2/api/platform/Platform/#ready).
|
* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic 2, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/api/platform/Platform/#ready).
|
||||||
* **Check that you are using the latest version of** `ionic-native`, you can install the latest version by running `npm i --save ionic-native@latest`
|
* **Check that you are using the latest version of** `ionic-native`, you can install the latest version by running `npm i --save ionic-native@latest`
|
||||||
|
|
||||||
###### Still having problems? submit an issue with the following details:
|
###### Still having problems? submit an issue with the following details:
|
||||||
|
@ -14,11 +14,11 @@ Run following command to install Ionic Native in your project.
|
|||||||
npm install @ionic-native/core --save
|
npm install @ionic-native/core --save
|
||||||
```
|
```
|
||||||
|
|
||||||
You also need to install the Ionic Native package for each plugin you want to add. Please see the [Ionic Native documentation](http://ionicframework.com/docs/v2/native/) for complete instructions on how to add and use the plugins.
|
You also need to install the Ionic Native package for each plugin you want to add. Please see the [Ionic Native documentation](http://ionicframework.com/docs/native/) for complete instructions on how to add and use the plugins.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/v2/native/](http://ionicframework.com/docs/v2/native/).
|
For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/native/](http://ionicframework.com/docs/native/).
|
||||||
|
|
||||||
### Basic Usage
|
### Basic Usage
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"sitePath": "../ionic-site",
|
"sitePath": "../ionic-site",
|
||||||
"v2DocsDir": "docs/v2/native",
|
"v2DocsDir": "docs/native",
|
||||||
"docsDest": "../ionic-site/content/docs/v2/native",
|
"docsDest": "../ionic-site/content/docs/native",
|
||||||
"pluginDir": "dist/@ionic-native"
|
"pluginDir": "dist/@ionic-native"
|
||||||
}
|
}
|
||||||
|
@ -30,7 +30,7 @@ function run {
|
|||||||
git pull origin master
|
git pull origin master
|
||||||
fi
|
fi
|
||||||
|
|
||||||
git rm -rf content/docs/v2/native/*/ || true
|
git rm -rf content/docs/native/*/ || true
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ module.exports = function jekyll(renderDocsProcessor) {
|
|||||||
|
|
||||||
docs.forEach(doc => {
|
docs.forEach(doc => {
|
||||||
doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-');
|
doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-');
|
||||||
doc.URL = doc.outputPath.replace('docs/v2//', 'docs/v2/')
|
doc.URL = doc.outputPath.replace('docs//', 'docs/')
|
||||||
.replace('/index.md', '')
|
.replace('/index.md', '')
|
||||||
.replace('content/', '');
|
.replace('content/', '');
|
||||||
});
|
});
|
||||||
@ -29,7 +29,7 @@ module.exports = function jekyll(renderDocsProcessor) {
|
|||||||
docType: 'nativeMenu',
|
docType: 'nativeMenu',
|
||||||
id: 'native_menu',
|
id: 'native_menu',
|
||||||
template: 'native_menu.template.html',
|
template: 'native_menu.template.html',
|
||||||
outputPath: 'content/_includes/v2_fluid/native_menu.html'
|
outputPath: 'content/_includes/fluid/native_menu.html'
|
||||||
});
|
});
|
||||||
|
|
||||||
return docs;
|
return docs;
|
||||||
|
2
scripts/docs/templates/common.template.html
vendored
2
scripts/docs/templates/common.template.html
vendored
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
layout: "v2_fluid/docs_base"
|
layout: "fluid/docs_base"
|
||||||
version: "<$ version.current.name $>"
|
version: "<$ version.current.name $>"
|
||||||
versionHref: "<$ version.current.href.replace('content/','') $>"
|
versionHref: "<$ version.current.href.replace('content/','') $>"
|
||||||
path: "<$ doc.path $>"
|
path: "<$ doc.path $>"
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<li class="capitalize {% if page.id == 'overview' %}active{% endif %}">
|
<li class="capitalize {% if page.id == 'overview' %}active{% endif %}">
|
||||||
<a href="/docs/v2/native/">Overview</a>
|
<a href="/docs/native/">Overview</a>
|
||||||
</li>
|
</li>
|
||||||
<li class="capitalize {% if page.id == 'mocking' %}active{% endif %}">
|
<li class="capitalize {% if page.id == 'mocking' %}active{% endif %}">
|
||||||
<a href="/docs/v2/native/browser.html">Browser Usage</a>
|
<a href="/docs/native/browser.html">Browser Usage</a>
|
||||||
</li>
|
</li>
|
||||||
<@- for doc in docs @><@ if doc.URL and doc.private != true and doc.beta != true @>
|
<@- for doc in docs @><@ if doc.URL and doc.private != true and doc.beta != true @>
|
||||||
<li class="capitalize {% if page.id == '<$ doc.name|lower|dashify $>' %}active{% endif %}">
|
<li class="capitalize {% if page.id == '<$ doc.name|lower|dashify $>' %}active{% endif %}">
|
||||||
|
2
scripts/docs/templates/readme.template.md
vendored
2
scripts/docs/templates/readme.template.md
vendored
@ -20,7 +20,7 @@ $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plug
|
|||||||
$ npm install --save @ionic-native/<$ doc.npmId $>
|
$ npm install --save @ionic-native/<$ doc.npmId $>
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Usage Documentation](https://ionicframework.com/docs/v2/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>)
|
## [Usage Documentation](https://ionicframework.com/docs/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>)
|
||||||
|
|
||||||
Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>)
|
Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user