New docs structure

posthtml · Oct 30, 2022 · 9a89c02 · 9a89c02
1 parent b0e4e0c
commit 9a89c02
Show file tree

Hide file tree

Showing 35 changed files with 14 additions and 2,287 deletions.
diff --git a/.clintonrc.json b/.clintonrc.json
@@ -4,7 +4,7 @@
     "tmp/**",
     "src/**",
     "lib/**",
-    "examples/**",
+    "docs-src/**",
     "docs/**",
     ".idea/**",
     "*.{html,jpg}",

diff --git a/.npmignore b/.npmignore
@@ -1,6 +1,6 @@
 node_modules
 coverage
-examples
+docs-src
 docs
 test
 .gitignore

diff --git a/examples/src/components/btn-link.html → docs-src/components/btn-link.html b/examples/src/components/btn-link.html → docs-src/components/btn-link.html
diff --git a/examples/src/components/button.html → docs-src/components/button.html b/examples/src/components/button.html → docs-src/components/button.html
diff --git a/examples/src/components/modal/body.html → docs-src/components/modal/body.html b/examples/src/components/modal/body.html → docs-src/components/modal/body.html
diff --git a/examples/src/components/modal/footer.html → docs-src/components/modal/footer.html b/examples/src/components/modal/footer.html → docs-src/components/modal/footer.html
diff --git a/examples/src/components/modal/header.html → docs-src/components/modal/header.html b/examples/src/components/modal/header.html → docs-src/components/modal/header.html
diff --git a/examples/src/components/modal/index.html → docs-src/components/modal/index.html b/examples/src/components/modal/index.html → docs-src/components/modal/index.html
diff --git a/examples/src/components/nav-link.html → docs-src/components/nav-link.html b/examples/src/components/nav-link.html → docs-src/components/nav-link.html
diff --git a/...les/src/components/test/child-parent.html → docs-src/components/test/child-parent.html b/...les/src/components/test/child-parent.html → docs-src/components/test/child-parent.html
diff --git a/examples/src/components/test/child.html → docs-src/components/test/child.html b/examples/src/components/test/child.html → docs-src/components/test/child.html
diff --git a/examples/src/components/test/child2.html → docs-src/components/test/child2.html b/examples/src/components/test/child2.html → docs-src/components/test/child2.html
diff --git a/examples/src/components/test/index.html → docs-src/components/test/index.html b/examples/src/components/test/index.html → docs-src/components/test/index.html
diff --git a/examples/src/components/test/parent.html → docs-src/components/test/parent.html b/examples/src/components/test/parent.html → docs-src/components/test/parent.html
diff --git a/...s/src/components/test/parent2-child2.html → docs-src/components/test/parent2-child2.html b/...s/src/components/test/parent2-child2.html → docs-src/components/test/parent2-child2.html
diff --git a/examples/src/components/test/parent2.html → docs-src/components/test/parent2.html b/examples/src/components/test/parent2.html → docs-src/components/test/parent2.html
diff --git a/examples/index.js → docs-src/index.js b/examples/index.js → docs-src/index.js
@@ -9,14 +9,13 @@ const markdownItToc = require('markdown-it-toc-done-right');
 // const {render} = require('posthtml-render');
 // const hljs = require('highlight.js');
 
-const src = './examples/src/pages/';
-const dist = './examples/dist/';
-const md = './examples/src/md';
-const docs = './docs/';
+const src = './docs-src/pages/';
+const dist = './docs/';
+const md = './docs-src/md';
 
 const plugins = [
   components({
-    root: './examples/src',
+    root: './docs-src',
     folders: ['components', 'layouts'],
     strict: true,
     expressions: {
@@ -74,7 +73,6 @@ readdirSync(src).forEach(file => {
     .process(html, options)
     .then(result => {
       writeFileSync(path.resolve(`${dist}${file}`), result.html, 'utf-8');
-      writeFileSync(path.resolve(`${docs}${file}`), result.html, 'utf-8');
     });
 });
 

diff --git a/examples/src/layouts/body.html → docs-src/layouts/body.html b/examples/src/layouts/body.html → docs-src/layouts/body.html
diff --git a/examples/src/layouts/footer.html → docs-src/layouts/footer.html b/examples/src/layouts/footer.html → docs-src/layouts/footer.html
diff --git a/examples/src/layouts/header.html → docs-src/layouts/header.html b/examples/src/layouts/header.html → docs-src/layouts/header.html
diff --git a/examples/src/layouts/html.html → docs-src/layouts/html.html b/examples/src/layouts/html.html → docs-src/layouts/html.html
diff --git a/examples/src/layouts/page.html → docs-src/layouts/page.html b/examples/src/layouts/page.html → docs-src/layouts/page.html
diff --git a/examples/src/md/changelog.md → docs-src/md/changelog.md b/examples/src/md/changelog.md → docs-src/md/changelog.md
diff --git a/examples/src/md/introduction.md → docs-src/md/introduction.md b/examples/src/md/introduction.md → docs-src/md/introduction.md
@@ -84,7 +84,7 @@ This is where your content will be injected.
 
 In next section you can find all available options and then more examples.
 
-See also the `examples` folder. You can run `npm run build-examples` to compile them.
+See also the `docs-src` folder. You can run `npm run build` to compile them.
 
 ## Options
 
@@ -752,7 +752,7 @@ You can add custom rules how attributes are parsed, as behind the scene it's use
 ## Examples
 
 You can work with `<slot>` and `<fill>` or you can create component for each "block" of your component, and you can also support both of them.
-You can find an example of this inside `examples/components/modal`. Below is a short explanation about the both approach.
+You can find an example of this inside `docs-src/components/modal`. Below is a short explanation about the both approach.
 
 ### Using slots
 

diff --git a/examples/src/pages/demo.html → docs-src/pages/demo.html b/examples/src/pages/demo.html → docs-src/pages/demo.html
diff --git a/examples/src/pages/docs.html → docs-src/pages/docs.html b/examples/src/pages/docs.html → docs-src/pages/docs.html
diff --git a/examples/src/pages/index.html → docs-src/pages/index.html b/examples/src/pages/index.html → docs-src/pages/index.html
diff --git a/examples/src/pages/test.html → docs-src/pages/test.html b/examples/src/pages/test.html → docs-src/pages/test.html
diff --git a/docs/docs.html b/docs/docs.html
@@ -284,9 +284,9 @@ <h2 id="basic-example" tabindex="-1">
             <p>In next section you can find all available options and then more examples.</p>
             <p>
               See also the
-              <code>examples</code>
+              <code>docs-src</code>
               folder. You can run
-              <code>npm run build-examples</code>
+              <code>npm run build</code>
               to compile them.
             </p>
             <h2 id="options" tabindex="-1">
@@ -1231,7 +1231,7 @@ <h2 id="examples" tabindex="-1">
               <code>&lt;fill&gt;</code>
               or you can create component for each &quot;block&quot; of your component, and you can also support both of them.
 You can find an example of this inside
-              <code>examples/components/modal</code>
+              <code>docs-src/components/modal</code>
               . Below is a short explanation about the both approach.
             </p>
             <h3 id="using-slots" tabindex="-1">

diff --git a/examples/dist/demo.html b/examples/dist/demo.html