Skip to content

Commit

Permalink
Build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@yarkovaleksei
yarkovaleksei committed Mar 18, 2021
1 parent 478c857 commit 4c36b66
Show file tree
Hide file tree
Showing 22 changed files with 78 additions and 44 deletions.
8 changes: 5 additions & 3 deletions docs/en/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,8 @@ <h3 id="setoptions">setOptions</h3>
<span class="hljs-keyword">this</span>.$storage.setOptions({
prefix: <span class="hljs-string">&apos;app_&apos;</span>,
driver: <span class="hljs-string">&apos;local&apos;</span>,
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span> <span class="hljs-comment">// 24 hours</span>
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span>, <span class="hljs-comment">// 24 hours</span>
replacer: (key, value) =&gt; value
})
}
}
Expand Down Expand Up @@ -789,7 +790,8 @@ <h3 id="prefix">prefix</h3>
<span class="hljs-keyword">this</span>.$storage.setOptions({
prefix: <span class="hljs-string">&apos;app_&apos;</span>,
driver: <span class="hljs-string">&apos;local&apos;</span>,
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span> <span class="hljs-comment">// 24 hours</span>
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span>, <span class="hljs-comment">// 24 hours</span>
replacer: (key, value) =&gt; value
})
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">this</span>.$storage.prefix) <span class="hljs-comment">// app_</span>
}
Expand Down Expand Up @@ -839,7 +841,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"API","level":"1.5","depth":1,"next":{"title":"Methods","level":"1.5.1","depth":2,"anchor":"#methods","path":"api.md","ref":"api.md#methods","articles":[{"title":"setOptions","level":"1.5.1.1","depth":3,"anchor":"#setoptions","path":"api.md","ref":"api.md#setoptions","articles":[]},{"title":"get","level":"1.5.1.2","depth":3,"anchor":"#get","path":"api.md","ref":"api.md#get","articles":[]},{"title":"pull","level":"1.5.1.3","depth":3,"anchor":"#pull","path":"api.md","ref":"api.md#pull","articles":[]},{"title":"set","level":"1.5.1.4","depth":3,"anchor":"#set","path":"api.md","ref":"api.md#set","articles":[]},{"title":"remember","level":"1.5.1.5","depth":3,"anchor":"#remember","path":"api.md","ref":"api.md#remember","articles":[]},{"title":"remove","level":"1.5.1.6","depth":3,"anchor":"#remove","path":"api.md","ref":"api.md#remove","articles":[]},{"title":"clear","level":"1.5.1.7","depth":3,"anchor":"#clear","path":"api.md","ref":"api.md#clear","articles":[]},{"title":"has","level":"1.5.1.8","depth":3,"anchor":"#has","path":"api.md","ref":"api.md#has","articles":[]},{"title":"key","level":"1.5.1.9","depth":3,"anchor":"#key","path":"api.md","ref":"api.md#key","articles":[]},{"title":"keys","level":"1.5.1.10","depth":3,"anchor":"#keys","path":"api.md","ref":"api.md#keys","articles":[]}]},"previous":{"title":"Options","level":"1.4","depth":1,"path":"options.md","ref":"options.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.0.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"api.md","mtime":"2019-12-21T19:47:44.118Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-12-21T20:20:03.066Z"},"basePath":".","book":{"language":"en"}});
gitbook.page.hasChanged({"page":{"title":"API","level":"1.5","depth":1,"next":{"title":"Methods","level":"1.5.1","depth":2,"anchor":"#methods","path":"api.md","ref":"api.md#methods","articles":[{"title":"setOptions","level":"1.5.1.1","depth":3,"anchor":"#setoptions","path":"api.md","ref":"api.md#setoptions","articles":[]},{"title":"get","level":"1.5.1.2","depth":3,"anchor":"#get","path":"api.md","ref":"api.md#get","articles":[]},{"title":"pull","level":"1.5.1.3","depth":3,"anchor":"#pull","path":"api.md","ref":"api.md#pull","articles":[]},{"title":"set","level":"1.5.1.4","depth":3,"anchor":"#set","path":"api.md","ref":"api.md#set","articles":[]},{"title":"remember","level":"1.5.1.5","depth":3,"anchor":"#remember","path":"api.md","ref":"api.md#remember","articles":[]},{"title":"remove","level":"1.5.1.6","depth":3,"anchor":"#remove","path":"api.md","ref":"api.md#remove","articles":[]},{"title":"clear","level":"1.5.1.7","depth":3,"anchor":"#clear","path":"api.md","ref":"api.md#clear","articles":[]},{"title":"has","level":"1.5.1.8","depth":3,"anchor":"#has","path":"api.md","ref":"api.md#has","articles":[]},{"title":"key","level":"1.5.1.9","depth":3,"anchor":"#key","path":"api.md","ref":"api.md#key","articles":[]},{"title":"keys","level":"1.5.1.10","depth":3,"anchor":"#keys","path":"api.md","ref":"api.md#keys","articles":[]}]},"previous":{"title":"Options","level":"1.4","depth":1,"path":"options.md","ref":"options.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.1.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"api.md","mtime":"2021-03-18T19:28:51.126Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2021-03-18T19:30:41.325Z"},"basePath":".","book":{"language":"en"}});
});
</script>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/en/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Installation","level":"1.2","depth":1,"path":"installation.md","ref":"installation.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.0.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"README.md","mtime":"2019-12-21T18:10:44.405Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-12-21T20:20:03.066Z"},"basePath":".","book":{"language":"en"}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Installation","level":"1.2","depth":1,"path":"installation.md","ref":"installation.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.1.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"README.md","mtime":"2019-12-21T18:10:44.405Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2021-03-18T19:30:41.325Z"},"basePath":".","book":{"language":"en"}});
});
</script>
</div>
Expand Down
7 changes: 4 additions & 3 deletions docs/en/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ <h1>
<h1 id="installation">Installation</h1>
<h3 id="direct-download--cdn">Direct Download / CDN</h3>
<p><a href="https://unpkg.com/vue2-storage/dist/vue2-storage" target="_blank">https://unpkg.com/vue2-storage/dist/vue2-storage</a></p>
<p><a href="https://unpkg.com" target="_blank">unpkg.com</a> provides NPM-based CDN links. The above link will always point to the latest release on NPM. You can also use a specific version/tag via URLs like <a href="https://unpkg.com/vue2-storage@5.0.0/dist/vue2-storage.js" target="_blank">https://unpkg.com/vue2-storage@5.0.0/dist/vue2-storage.js</a></p>
<p><a href="https://unpkg.com" target="_blank">unpkg.com</a> provides NPM-based CDN links. The above link will always point to the latest release on NPM. You can also use a specific version/tag via URLs like <a href="https://unpkg.com/vue2-storage@5.1.0/dist/vue2-storage.js" target="_blank">https://unpkg.com/vue2-storage@5.1.0/dist/vue2-storage.js</a></p>
<p>Include vue2-storage after Vue and use according to the documentation:</p>
<pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://unpkg.com/vue/dist/vue.js&quot;</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://unpkg.com/vue2-storage/dist/vue2-storage.js&quot;</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
Expand All @@ -427,7 +427,8 @@ <h3 id="npm">NPM</h3>
Vue.use(Vue2Storage, {
prefix: <span class="hljs-string">&apos;app_&apos;</span>,
driver: <span class="hljs-string">&apos;local&apos;</span>,
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span> <span class="hljs-comment">// 24 hours</span>
ttl: <span class="hljs-number">60</span> * <span class="hljs-number">60</span> * <span class="hljs-number">24</span> * <span class="hljs-number">1000</span>, <span class="hljs-comment">// 24 hours</span>
replacer: (key, value) =&gt; value
})
</code></pre>
<p>You don&apos;t need to do this when using global script tags.</p>
Expand Down Expand Up @@ -481,7 +482,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Installation","level":"1.2","depth":1,"next":{"title":"Getting Started","level":"1.3","depth":1,"path":"started.md","ref":"started.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.0.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"installation.md","mtime":"2019-12-21T18:10:44.405Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-12-21T20:20:03.066Z"},"basePath":".","book":{"language":"en"}});
gitbook.page.hasChanged({"page":{"title":"Installation","level":"1.2","depth":1,"next":{"title":"Getting Started","level":"1.3","depth":1,"path":"started.md","ref":"started.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","github"],"root":"./","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/yarkovaleksei/vue2-storage/"},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/yarkovaleksei/vue2-storage/tree/master/gitbook"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"packageName":"vue2-storage","packageVersion":"5.1.0"},"language":"en","links":{"sharing":{"facebook":true,"twitter":true}},"gitbook":"*"},"file":{"path":"installation.md","mtime":"2021-03-18T19:26:54.856Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2021-03-18T19:30:41.325Z"},"basePath":".","book":{"language":"en"}});
});
</script>
</div>
Expand Down
Loading

0 comments on commit 4c36b66

Please sign in to comment.