htmlnano 1.0.0 → 2.0.0

package/docs/docs/060-contribute.md

@@ -0,0 +1,16 @@
+# Contribute
+
+Since the minifier is modular, it's very easy to add new modules:
+
+1. Create a ES6-file inside `lib/modules/` with a function that does some minification. For example you can check [`lib/modules/example.es6`](https://github.com/posthtml/htmlnano/blob/master/lib/modules/example.es6).
+
+2. Add the module's name into one of those [presets](https://github.com/posthtml/htmlnano/tree/master/lib/presets). You can choose either `ampSafe`, `max`, or `safe`.
+
+3. Create a JS-file inside `test/modules/` with some unit-tests.
+
+4. Describe your module in the section "[Modules](https://github.com/posthtml/htmlnano/blob/master/README.md#modules)".
+
+5. Send me a pull request.
+
+Other types of contribution (bug fixes, documentation improves, etc) are also welcome!
+Would like to contribute, but don't have any ideas what to do? Check out [our issues](https://github.com/posthtml/htmlnano/labels/help%20wanted).

package/docs/docusaurus.config.js

@@ -0,0 +1,60 @@
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').DocusaurusConfig} */
+module.exports = {
+    title: 'htmlnano',
+    tagline: 'Modular HTML minifier',
+    url: 'https://htmlnano.netlify.app',
+    favicon: 'favicon.ico',
+    baseUrl: '/',
+    onBrokenLinks: 'throw',
+    onBrokenMarkdownLinks: 'warn',
+    organizationName: 'posthtml',
+    projectName: 'htmlnano',
+    trailingSlash: false,
+    themeConfig: {
+        navbar: {
+            title: 'htmlnano',
+            items: [
+                {
+                    type: 'docsVersionDropdown',
+                    position: 'right',
+                    dropdownActiveClassDisabled: true,
+                },
+                {
+                    href: 'https://github.com/posthtml/htmlnano',
+                    label: 'GitHub',
+                    position: 'right',
+                },
+            ],
+        },
+        prism: {
+            theme: lightCodeTheme,
+            darkTheme: darkCodeTheme,
+        },
+    },
+    presets: [
+        [
+            '@docusaurus/preset-classic',
+            {
+                docs: {
+                    sidebarPath: require.resolve('./sidebars.js'),
+                    routeBasePath: '/',
+                    editUrl: 'https://github.com/posthtml/htmlnano/edit/master/docs/',
+                },
+            },
+        ],
+    ],
+};
+
+
+const algoliaConfig = {
+    apiKey: process.env.ALGOLIA_API_KEY,
+    indexName: 'htmlnano',
+    contextualSearch: true,
+};
+
+if (algoliaConfig.apiKey) {
+    module.exports.themeConfig.algolia = algoliaConfig;
+}

package/docs/netlify.toml

@@ -0,0 +1,4 @@
+[build]
+  base = "docs/"
+  publish = "build/"
+  command = "npm run build"