Update docs

Author: Hexagon

contributing.md

@@ -0,0 +1 @@
+gem "jekyll-default-layout"

docs/Gemfile

@@ -0,0 +1,18 @@
+title: Proper Tags
+
+description: Pure ESM fork of the popular package common-tags.
+
+remote_theme: just-the-docs/just-the-docs
+
+url: https://proper-tags.56k.guru
+
+aux_links:
+  GitHub Repository: https://github.com/hexagon/proper-tags
+  NPM Library: https://npmjs.com/package/proper-tags
+  Deno Library: https://deno.land/x/proper_tags
+
+plugins:
+  - jekyll-relative-links
+  - jekyll-default-layout
+
+# color_scheme: dark

docs/_config.yml

@@ -0,0 +1 @@
+<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-9224018205432249" crossorigin="anonymous"></script>

docs/_includes/head_custom.html

@@ -0,0 +1,65 @@
+---
+layout: page
+title: "Contributing"
+nav_order: 4
+---
+
+# Contribution Guidelines
+
+---
+
+Thank you for considering contributing to the `proper-tags` package! Here's a comprehensive guide to help you through the process.
+
+## Setup
+
+1. **Fork the Repository**: Use the GitHub interface to fork this repository to your account.
+2. **Clone the Fork**: On your local machine, open a terminal or command prompt. Use the following command to clone the forked repository:  
+   `git clone https://github.com/hexagon/proper-tags.git`
+3. **Navigate to the Repository**: Change to the project directory using:  
+   `cd proper-tags`
+4. **Install Dependencies**: To ensure you have all the required dependencies, run:  
+   `npm ci`
+
+## Working on Your Contribution
+
+1. **Create a New Branch**: Always create a new branch for your work to ensure master remains clean. Use:  
+   `git checkout -b feature/<feature-name>` or `git checkout -b bugfix/<bug-name>`
+2. **Stay Updated**: Ensure you regularly pull the latest changes from the upstream repository to keep your fork up-to-date:  
+   `git pull origin master`
+
+## Tests
+
+1. **Writing Tests**: Make sure you include tests that cover any new logic or features you add. A good test not only confirms the correct behavior but can also serve as documentation for how a certain feature works.
+2. **Running Tests**: This project uses [AVA](https://github.com/sindresorhus/ava) for testing. To run tests, execute:  
+   `npm test`
+3. **Testing Convention**: The project is set up to search for test files in the `src` directory that have the `.test.js` extension.
+
+## Code Style and Quality
+
+1. **Coding Standards**: Adhere to the code style and patterns established in the project. This ensures consistency and readability across all contributions.
+2. **Linting**: The project uses [Prettier](https://github.com/prettier/prettier) and [ESLint](https://github.com/eslint/eslint) to maintain a consistent code style. Before committing your changes, ensure your code adheres to the rules. Run:  
+   `npm run lint`
+3. **Auto-fixing Issues**: Some linting issues can be automatically fixed. Use the following command to attempt auto-fixes:  
+   `npm run lint:fix`
+
+## Committing and Pushing Changes
+
+1. **Commit Messages**: Write clear and concise commit messages describing the changes you made.
+2. **Atomic Commits**: Make sure each commit contains related changes. Avoid bundling unrelated changes into a single commit.
+3. **Push Your Changes**: Once you're ready to submit your changes, push the branch to your forked repository:  
+   `git push origin feature/<feature-name>`
+
+## Submitting a Pull Request
+
+1. **Open a Pull Request**: Navigate to the GitHub page of your forked repository and click on the "New pull request" button.
+2. **Describe Your Changes**: In the pull request description, provide a detailed explanation of the changes you've made. If your PR is fixing a bug, provide steps to reproduce the bug.
+3. **Wait for Review**: Maintainers of the `proper-tags` package will review your pull request. Address any feedback or changes requested.
+
+## Final Notes
+
+- Please ensure your code doesn't introduce any regressions by running the full test suite before submitting a PR.
+- Always reference relevant issues or discussions in your pull requests.
+- Contributions aren't just about code! If you find a typo, a confusing piece of documentation, or have ideas for improving the project structure, we'd love to hear from you.
+
+Thank you for helping improve `proper-tags`!
+```

docs/contributing.md

@@ -0,0 +1,29 @@
+---
+layout: page
+title: "Overview"
+nav_order: 1
+---
+
+# proper-tags Documentation
+
+---
+
+**proper-tags** is an evolved version of the widely-used CommonJS package **common-tags**. It has been updated with the following considerations for modern JavaScript environments:
+
+🌟 Extendable: proper-tags comes with built-in tools for creating custom tags.
+📦 ESM Code Base: With support for ESM/ECMAScript Modules, it ensures native compatibility with modern development tools.
+🦕 Deno Compatibility: Designed specifically to function seamlessly with the Deno runtime.
+📝 TypeScript Definitions: Integrated TypeScript typings make development in TypeScript a breeze.
+🔄 API Consistency: Its interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.
+
+## Sample Usage
+
+```js
+import { html } from 'proper-tags';
+
+html`
+  <div id="user-card">
+    <h2>${user.name}</h2>
+  </div>
+```
+

docs/index.md

@@ -0,0 +1,39 @@
+---
+layout: page
+title: "Installation"
+nav_order: 2
+---
+
+# Installation
+
+---
+
+## Node
+
+**Install**
+    
+    npm install proper-tags
+
+**ESM Import**
+
+    import { stripIndent } from 'proper-tags';
+
+**Legacy CommonJS Require**
+
+    const { stripIndent } = require('proper-tags');
+
+## Deno 
+
+To use `proper-tags` with **Deno**, follow the import example:
+
+    import { html } from 'https://deno.land/x/proper_tags/dist/proper-tags.js';
+
+> **Note:** Make sure to freeze the url to a specific version
+
+## CDN/Browser
+
+For usage via **jsdelivr** in the browser:
+
+    <script src="https://cdn.jsdelivr.net/npm/proper-tags@2.0.0-beta.0/dist/proper-tags.umd.js"></script>
+
+> **Note:** Ensure you're using the latest version in the URL.