diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml new file mode 100644 index 0000000000..96c81149d5 --- /dev/null +++ b/.github/workflows/jekyll-gh-pages.yml @@ -0,0 +1,53 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll with GitHub Pages dependencies preinstalled + +on: + # Runs on pushes targeting the default branch + push: + branches: ["githubpages"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./ + destination: ./_site + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000000..cc46c2ff31 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,24 @@ +# Site settings +title: "Glaze" +description: "Glaze: a high performance C++ JSON and interface library" +baseurl: "/glaze" # Replace 'repositoryname' with your repository name +url: "https://stephenberry.github.io" # Replace 'yourusername' with your GitHub username + +# Build settings +theme: jekyll-theme-minimal # Choose any supported theme +markdown: kramdown +plugins: + - jekyll-feed + +# Include the 'docs' folder in the build +include: + - "docs" + +# Exclude unnecessary files or directories +exclude: + - "Gemfile" + - "Gemfile.lock" + - "node_modules" + - ".github" + +# Other settings as needed diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..e5eeecdea7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,42 @@ +--- +layout: default +title: "Home" +--- + +# Welcome to Your Project Name + +Welcome to the homepage of **Your Project Name**! This project is designed to help you [briefly describe what your project does]. + +## Table of Contents + +- [Introduction]({{ site.baseurl }}/docs/introduction.html) +- [Getting Started]({{ site.baseurl }}/docs/getting-started.html) +- [Usage Guide]({{ site.baseurl }}/docs/usage-guide.html) +- [API Reference]({{ site.baseurl }}/docs/api-reference.html) +- [FAQ]({{ site.baseurl }}/docs/faq.html) + +## About This Project + +Provide some background about your project here. Explain its purpose, features, and any other relevant details that visitors might find useful. + +## Quick Links + +- [Documentation]({{ site.baseurl }}/docs/) +- [GitHub Repository](https://github.com/yourusername/your-repository) +- [Issues]({{ site.baseurl }}/issues) +- [Contributing Guidelines]({{ site.baseurl }}/CONTRIBUTING.html) +- [License]({{ site.baseurl }}/LICENSE.html) + +## Getting Involved + +We welcome contributions! If you're interested in contributing to this project, please read our [contributing guidelines]({{ site.baseurl }}/CONTRIBUTING.html) to get started. + +## Contact + +If you have any questions, feel free to reach out: + +- **Email:** [youremail@example.com](mailto:youremail@example.com) +- **Twitter:** [@yourtwitterhandle](https://twitter.com/yourtwitterhandle) + +--- +© {{ site.time | date: "%Y" }} Your Name. All rights reserved.