diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..59f293f --- /dev/null +++ b/.github/workflows/main.yaml @@ -0,0 +1,41 @@ +name: Deploy Hugo and TypeDoc Site to GitHub Pages + +on: + push: + branches: + - main + +jobs: + build-deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: '0.135.0' + + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + node-version: '20.11.0' + + - name: Install Dependencies + run: npm install + + - name: Generate TypeDoc Documentation + run: npx typedoc + + - name: Build Hugo site + run: | + hugo --minify + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public + publish_branch: gh-pages diff --git a/.gitignore b/.gitignore index 7160a8f..df9a975 100644 --- a/.gitignore +++ b/.gitignore @@ -72,3 +72,6 @@ antlr-*.jar build/ dist/ website/ + +## hugo static/api for typedoc outputs +site/static/api/ \ No newline at end of file diff --git a/README.md b/README.md index b7d2294..79d6c66 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ CodeMetrica is a work-in-progress framework designed to perform static analysis for multiple programming languages. It focuses on calculating various source code metrics and detecting code smells, providing a generalized approach to analyzing and improving code quality across different languages. +> [!CAUTION] +> +> The project is under active development, expect things to break every once in a while. + ## Features * Multi-language support: CodeMetrica is built to support multiple programming languages, with specific support for Java and Python currently in place. diff --git a/package.json b/package.json index 84c726d..dbbc7d5 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "test": "jest", "dev": "cd example && npx tsx index.ts", "build": "tsc", - "docs": "rm -rf website/* & npx typedoc" + "docs": "rm -rf site/static/api && npx typedoc && hugo" }, "keywords": [], "type": "module", diff --git a/site/.editorconfig b/site/.editorconfig new file mode 100644 index 0000000..574c0a2 --- /dev/null +++ b/site/.editorconfig @@ -0,0 +1,20 @@ +# editorconfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.toml] +max_line_length = 100 + +[*.md] +trim_trailing_whitespace = false + +[layouts/shortcodes/*.html] +insert_final_newline = false diff --git a/site/.gitignore b/site/.gitignore new file mode 100644 index 0000000..bda4caf --- /dev/null +++ b/site/.gitignore @@ -0,0 +1,7 @@ +# IDEs +.idea/ + +# Hugo +resources/ +public/ +jsconfig.json diff --git a/docs/CodeMetrica.md b/site/.hugo_build.lock similarity index 100% rename from docs/CodeMetrica.md rename to site/.hugo_build.lock diff --git a/site/README.md b/site/README.md new file mode 100644 index 0000000..9f11c67 --- /dev/null +++ b/site/README.md @@ -0,0 +1,32 @@ +# [Hugo Docs Theme](https://github.com/HugoBlox/theme-documentation) + +[![Screenshot](https://raw.githubusercontent.com/HugoBlox/theme-documentation/main/.github/preview.png)](https://hugoblox.com/templates/details/docs/) + +The Hugo **Documentation Template** empowers with everything you need to build a beautiful documentation website, including a customizable block-based homepage and blog. It's ultra-fast and easy, letting you focus on your content. It's also no-code by default, so no JavaScript knowledge is required unlike other templates! + +️**Trusted by 250,000+ creators, teams, and organizations.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐ + +[![Get Started](https://img.shields.io/badge/-Get%20started-ff4655?style=for-the-badge)](https://hugoblox.com/templates/details/docs/) +[![Discord](https://img.shields.io/discord/722225264733716590?style=for-the-badge)](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138) +[![Twitter Follow](https://img.shields.io/twitter/follow/GetResearchDev?label=Follow%20on%20Twitter)](https://twitter.com/GetResearchDev) + +[Check out the latest demo](https://hugo-docs-theme.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/). + +The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs. + +- 👉 [**Get Started**](https://hugoblox.com/templates/details/docs/) +- 📚 [View the **documentation**](https://docs.hugoblox.com/) +- 💬 [Chat with the **Hugo Blox Builder community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io) +- ⬇️ **Automatically import citations from BibTeX** with the [Academic File Converter](https://github.com/GetRD/academic-file-converter) +- 🐦 Share your new site with the community: [@GetResearchDev](https://twitter.com/GetResearchDev) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithHugoBlox](https://twitter.com/search?q=%23MadeWithHugoBlox&src=typed_query) +- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA) +- 🚀 [Contribute improvements](https://github.com/HugoBlox/hugo-blox-builder/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/hugo-blox-builder/issues) +- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases) + +## We ask you, humbly, to support this open source movement + +Today we ask you to defend the open source independence of the Hugo Blox Builder and themes 🐧 + +We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way. + +### [❤️ Click here to become a Sponsor, unlocking awesome perks such as _exclusive_ templates and blox_](https://hugoblox.com/sponsor/) diff --git a/site/assets/css/custom.css b/site/assets/css/custom.css new file mode 100644 index 0000000..f2ff828 --- /dev/null +++ b/site/assets/css/custom.css @@ -0,0 +1,3 @@ +footer .powered-by:last-child { + display: none; +} \ No newline at end of file diff --git a/site/assets/css/themes/custom.css b/site/assets/css/themes/custom.css new file mode 100644 index 0000000..ae5e000 --- /dev/null +++ b/site/assets/css/themes/custom.css @@ -0,0 +1,13 @@ +:root { + --color-primary-50: 250 245 255; + --color-primary-100: 243 232 255; + --color-primary-200: 233 213 255; + --color-primary-300: 216 180 254; + --color-primary-400: 192 132 252; + --color-primary-500: 168 85 247; + --color-primary-600: 147 51 234; + --color-primary-700: 126 34 206; + --color-primary-800: 107 33 168; + --color-primary-900: 88 28 135; + --color-primary-950: 59 7 100; + } \ No newline at end of file diff --git a/site/assets/media/codemetrica.svg b/site/assets/media/codemetrica.svg new file mode 100644 index 0000000..e57c2a0 --- /dev/null +++ b/site/assets/media/codemetrica.svg @@ -0,0 +1,15 @@ + + + +Created with Fabric.js 5.2.4 + + + + + + + + + + + \ No newline at end of file diff --git a/site/assets/media/icon.png b/site/assets/media/icon.png new file mode 100644 index 0000000..08e5240 Binary files /dev/null and b/site/assets/media/icon.png differ diff --git a/site/assets/media/icons/custom/.gitkeep b/site/assets/media/icons/custom/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/site/config/_default/hugo.yaml b/site/config/_default/hugo.yaml new file mode 100644 index 0000000..ab74bcf --- /dev/null +++ b/site/config/_default/hugo.yaml @@ -0,0 +1,99 @@ +# Configuration of Hugo +# Guide: https://docs.hugoblox.com/tutorial/ +# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings +# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/ + +title: "Hugo Docs" # Website name +baseURL: 'https://example.com/' # Website URL + +############################ +## PAGE OPTIONS +############################ + +cascade: + # Docs folder options + - _target: + path: /docs/** + editable: false + show_breadcrumb: true + # Hide date from Next In Series + show_date: false + # Show date modified at end of content + show_date_updated: true + # Blog post options + - _target: + path: /blog/** + kind: page + pager: true + editable: false + hide_date: false + show_date_updated: true + reading_time: true + commentable: false + show_related: true + share: true + # Just use Breadcrumb for navigation on blog post pages? + show_breadcrumb: false + header: + navbar: + enable: true + +############################ +## LANGUAGE +############################ + +defaultContentLanguage: en +hasCJKLanguage: false +defaultContentLanguageInSubdir: false +removePathAccents: true + +############################ +## ADVANCED +############################ + +build: + writeStats: true +enableGitInfo: false +summaryLength: 30 +pagination: + pagerSize: 10 +enableEmoji: true +enableRobotsTXT: true +footnotereturnlinkcontents: ^ +ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$] +enableInlineShortcodes: true +permalinks: + authors: '/author/:slug/' + tags: '/tag/:slug/' + categories: '/category/:slug/' +disableAliases: true +outputs: + home: [HTML, RSS, WebAppManifest, headers, redirects, backlinks] + page: [HTML] + section: [HTML, RSS] +imaging: + resampleFilter: lanczos + quality: 85 + anchor: smart +timeout: 600000 +taxonomies: + tag: tags + category: categories + author: authors +markup: + _merge: deep +related: + threshold: 80 + includeNewer: true + toLower: true + indices: + - name: tags + weight: 100 + - name: categories + weight: 70 +security: + _merge: deep +sitemap: + _merge: deep +minify: + _merge: deep diff --git a/site/config/_default/languages.yaml b/site/config/_default/languages.yaml new file mode 100644 index 0000000..88fa733 --- /dev/null +++ b/site/config/_default/languages.yaml @@ -0,0 +1,22 @@ +# Languages +# Create a section for each of your site's languages. +# Documentation: https://docs.hugoblox.com/reference/language/ + +# Default language +en: + languageCode: en-us + # Uncomment for multi-lingual sites, and move English content into `en` sub-folder. + #contentDir: content/en + +# Uncomment the lines below to configure your website in a second language. +#zh: +# languageCode: zh-Hans +# contentDir: content/zh +# title: Chinese website title... +# params: +# description: Site description in Chinese... +# menu: +# main: +# - name: 传 +# url: '#about' +# weight: 1 diff --git a/site/config/_default/menus.yaml b/site/config/_default/menus.yaml new file mode 100644 index 0000000..fceaae9 --- /dev/null +++ b/site/config/_default/menus.yaml @@ -0,0 +1,34 @@ +# Navigation Links +# The weight parameter defines the order that the links will appear in. + +main: + - name: Home + url: / + weight: 10 + - name: Documentation + url: docs/ + weight: 20 + - name: API + url: api/ + weight: 30 + - name: Showcase + url: showcase/ + weight: 40 + - name: Community + url: community/ + weight: 50 + +sidebar: + - identifier: more + name: Still need help? + params: + type: separator + weight: 1 + - identifier: knowledge-hub + name: "Knowledge Hub" + pageRef: "knowledge-hub" + weight: 2 + - identifier: discuss + name: "Discuss" + url: "https://github.com/sparklabOrg/codemetrica/discussions/categories/q-a" + weight: 3 diff --git a/site/config/_default/module.yaml b/site/config/_default/module.yaml new file mode 100644 index 0000000..ac2a62a --- /dev/null +++ b/site/config/_default/module.yaml @@ -0,0 +1,25 @@ +############################ +## HUGO MODULES +## Install or uninstall themes and plugins here. +## Docs: https://gohugo.io/hugo-modules/ +############################ + +imports: + - path: github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify + - path: github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind + +# Install any Hugo Blox within the `hugo-blox/blox/` folder +mounts: + - source: hugo-blox/blox/community + target: layouts/partials/blox/community/ + includeFiles: '**.html' + - source: hugo-blox/blox/all-access + target: layouts/partials/blox/ + includeFiles: '**.html' + - source: hugo-blox/blox + target: assets/dist/community/blox/ + includeFiles: '**.css' + - source: layouts + target: layouts + - source: assets + target: assets diff --git a/site/config/_default/params.yaml b/site/config/_default/params.yaml new file mode 100644 index 0000000..875fe26 --- /dev/null +++ b/site/config/_default/params.yaml @@ -0,0 +1,84 @@ +# SITE SETUP +# Guide: https://docs.hugoblox.com/tutorial/ +# Documentation: https://docs.hugoblox.com/ +# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/ + +# Appearance +appearance: + mode: light + color: custom + +# SEO +marketing: + seo: + site_type: Project + local_business_type: '' + org_name: 'SparkLab' + description: 'A library for measuring software metrics and detecting code smells.' + twitter: '' + analytics: + google_analytics: '' + google_tag_manager: '' + microsoft_clarity: '' + baidu_tongji: '' + plausible: '' + fathom: '' + pirsch: '' + verification: + google: '' + baidu: '' + +# Site header +header: + navbar: + enable: true + blox: "navbar" + align: "center" + fixed_to_top: true + logo: + text: "Codemetrica" + # Logo filename in `assets/media/` folder + filename: "codemetrica.svg" + # button: + # enable: true + # text: "Get Started" + # url: "docs/" + show_search: true + show_theme_chooser: true + +# Site footer +footer: + copyright: + notice: '© {year} CodeMetrica. This work is licensed under GPL-3.0.' + license: + enable: false + allow_derivatives: false + share_alike: false + allow_commercial: false + +# Localization +locale: + date_format: 'Jan 2, 2006' + time_format: '3:04 PM' + +# Site features +features: + math: + enable: false + privacy_pack: + enable: false + repository: + url: 'https://github.com/sparklabOrg/codemetrica' + content_dir: '' + branch: 'main' + feedback: + responses: + positive: 'Glad to hear it! [Any ideas for improvements?](https://github.com///issues/new).' + negative: 'Sorry to hear that. [Please tell us how we can improve](https://github.com///issues/new).' + comment: + provider: '' + giscus: + repo: '' + repo_id: '' + category: '' + category_id: '' diff --git a/site/content/_index.md b/site/content/_index.md new file mode 100644 index 0000000..b1ffbca --- /dev/null +++ b/site/content/_index.md @@ -0,0 +1,99 @@ +--- +title: 'Home' +date: 2023-10-24 +type: landing + +design: + # Default section spacing + spacing: "6rem" + +sections: + - block: hero + content: + title: Effortlessly Measure Software Metrics and Detect Smells + text: Codemetrica delivers precise software metrics and code smell detection engine for multiple languages. Gain insights into code health with accurate analysis. + primary_action: + text: Read the docs + url: /docs/ + icon: rocket-launch + secondary_action: + text: See examples + url: /example/ + announcement: + text: "This project is in early development. Expect breaking changes." + link: + text: "Contribute" + url: "https://github.com/sparklabOrg/codemetrica/CONTRIBUTING.md" + design: + spacing: + padding: [0, 0, 0, 0] + margin: [0, 0, 0, 0] + # For full-screen, add `min-h-screen` below + css_class: "" + background: + color: "" + image: + # Add your image background to `assets/media/`. + filename: "" + filters: + brightness: 0.3 + # - block: stats + # content: + # items: + # - statistic: "1M+" + # description: | + # Websites built + # with Hugo Blox + # - statistic: "10k+" + # description: | + # GitHub stars + # since 2016 + # - statistic: "3k+" + # description: | + # Discord community + # for support + design: + # Section background color (CSS class) + css_class: "bg-gray-100 dark:bg-gray-800" + # Reduce spacing + spacing: + padding: ["1rem", 0, "1rem", 0] + - block: features + id: features + content: + title: Features + text: Codemetrica is designed to be a one stop solution for all your code metrics and smell detection needs. Explore a comprehensive list of features in the documentation. + items: + - name: Code Metrics + icon: scale + description: "Calculate metrics: Cyclomatic complexity, LOC..." + - name: Code Smells + icon: trash + description: "Detect code smells: God class, DIT" + - name: Test Smells + icon: trash + description: "Detect code smells: God class, DIT" + - name: Energy Smells + icon: light-bulb + description: Coming soon! + + - name: Code Clone + icon: document-duplicate + description: Coming soon! + + # - name: Analyze repos + # icon: code-bracket + # description: Coming soon! + # - block: cta-card + # content: + # title: "Start Writing with the #1 Effortless Documentation Platform" + # text: Hugo Blox Docs Theme brings all your technical knowledge together in a single, centralized knowledge base. Easily search and edit it with the tools you use every day! + # button: + # text: Get Started + # url: https://hugoblox.com/templates/details/docs/ + # design: + # card: + # # Card background color (CSS class) + # css_class: "bg-primary-700" + # css_style: "" +--- diff --git a/site/content/authors/_index.md b/site/content/authors/_index.md new file mode 100644 index 0000000..c5e4b7b --- /dev/null +++ b/site/content/authors/_index.md @@ -0,0 +1,9 @@ +--- +# To publish author profile pages, remove all the `_build` and `cascade` settings below. +_build: + render: never +cascade: + _build: + render: never + list: always +--- diff --git a/site/content/authors/admin/_index.md b/site/content/authors/admin/_index.md new file mode 100644 index 0000000..ebc5fef --- /dev/null +++ b/site/content/authors/admin/_index.md @@ -0,0 +1,59 @@ +--- +# Display name +title: 吳健雄 + +# Name pronunciation (optional) +name_pronunciation: Chien Shiung Wu + +# Full name (for SEO) +first_name: Shiung Wu +last_name: Chien + +# Status emoji +status: + icon: ☕️ + +# Is this the primary user of the site? +superuser: true + +# Role/position/tagline +role: Professor of Artificial Intelligence + +# Organizations/Affiliations to show in About widget +organizations: + - name: Stanford University + url: https://www.stanford.edu/ + +# Short bio (displayed in user profile at end of posts) +bio: My research interests include distributed robotics, mobile computing and programmable matter. + +# Social Networking +# Need to use another icon? Simply download the SVG icon to your `assets/media/icons/` folder. +profiles: + - icon: at-symbol + url: 'mailto:your-email@example.com' + label: E-mail Me + - icon: brands/x + url: https://twitter.com/GetResearchDev + - icon: brands/instagram + url: https://www.instagram.com/ + - icon: brands/linkedin + url: https://www.linkedin.com/ + # Link to a PDF of your resume/CV - upload it to `static/uploads/resume.pdf` + - icon: academicons/cv + url: uploads/resume.pdf + label: Download my resume + - icon: rss + url: ./post/index.xml + label: Subscribe to my blog via RSS feed + +# Highlight the author in author lists? (true/false) +highlight_name: true + +# Author's website URL +website: "" +--- + +Chien Shiung Wu is a professor of artificial intelligence at the Stanford AI Lab. Her research interests include +distributed robotics, mobile computing and programmable matter. She leads the Robotic Neurobiology group, which develops +self-reconfiguring robots, systems of self-organizing robots, and mobile sensor networks. diff --git a/site/content/authors/admin/avatar.jpg b/site/content/authors/admin/avatar.jpg new file mode 100644 index 0000000..49337e4 Binary files /dev/null and b/site/content/authors/admin/avatar.jpg differ diff --git a/site/content/blog/_index.md b/site/content/blog/_index.md new file mode 100644 index 0000000..f040c7e --- /dev/null +++ b/site/content/blog/_index.md @@ -0,0 +1,5 @@ +--- +title: Blog +view: date-title-summary +url: /blog/ +--- diff --git a/site/content/blog/v1.0.0/featured.jpg b/site/content/blog/v1.0.0/featured.jpg new file mode 100644 index 0000000..8c97312 Binary files /dev/null and b/site/content/blog/v1.0.0/featured.jpg differ diff --git a/site/content/blog/v1.0.0/index.md b/site/content/blog/v1.0.0/index.md new file mode 100644 index 0000000..694f26e --- /dev/null +++ b/site/content/blog/v1.0.0/index.md @@ -0,0 +1,41 @@ +--- +title: v1.0.0 Released! +summary: Hugo v1.0.0 released. Download now and follow the guide to get started in 5 minutes! +date: 2023-01-01 +authors: + - admin +tags: + - Hugo + - Hugo Blox + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +Hugo v1.0.0 is now available! This release includes new experimental features to try out, improvements to accessibility, the ability for plugins to customize image optimization in Markdown, and many more improvements and bug fixes. + +Highlights include: + +- New config options +- Improved accessibility +- Customizable image optimization in Markdown + +Thank you to everyone who contributed to this release! + +## New Features + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## Bug Fixes + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## How to Upgrade + +Simply run the following command in your terminal: + +```bash +hugo mod get -u github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind@main +``` + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. diff --git a/site/content/blog/v2.0.0/featured.jpg b/site/content/blog/v2.0.0/featured.jpg new file mode 100644 index 0000000..8c97312 Binary files /dev/null and b/site/content/blog/v2.0.0/featured.jpg differ diff --git a/site/content/blog/v2.0.0/index.md b/site/content/blog/v2.0.0/index.md new file mode 100644 index 0000000..1c2d1a6 --- /dev/null +++ b/site/content/blog/v2.0.0/index.md @@ -0,0 +1,41 @@ +--- +title: v2.0.0 Released! +summary: Hugo v2.0.0 released. Download now and follow the guide to get started in 5 minutes! +date: 2024-01-19 +authors: + - admin +tags: + - Hugo + - Hugo Blox + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +Hugo v2.0.0 is now available! This release includes new experimental features to try out, improvements to accessibility, the ability for plugins to customize image optimization in Markdown, and many more improvements and bug fixes. + +Highlights include: + +- New config options +- Improved accessibility +- Customizable image optimization in Markdown + +Thank you to everyone who contributed to this release! + +## New Features + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## Bug Fixes + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## How to Upgrade + +Simply run the following command in your terminal: + +```bash +hugo mod get -u github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind@main +``` + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. diff --git a/site/content/community/index.md b/site/content/community/index.md new file mode 100644 index 0000000..2fd5d6d --- /dev/null +++ b/site/content/community/index.md @@ -0,0 +1,36 @@ +--- +title: Community +toc: true +reading_time: false +pager: false +--- + +## Support + +Get support fast. Hugo Blox has the largest Hugo community on Discord, consisting of thousands of creators, developers, and startups. + +## Docs + +- View the [Hugo Blox Documentation](https://docs.hugoblox.com/) + +## Live Chat {#chat} + +- Join the [Hugo Blox Online Chat](https://discord.gg/z8wNYzb) + - _#using-hugo-blox_ for user help + - _#contributors_ for contributing help + +## Feature requests {#feature-requests} + +For new feature requests, create a post on our [GitHub Issues](https://github.com/HugoBlox/hugo-blox-builder/issues). You can also upvote existing feature requests with a 👍 + +## News {#news} + +Follow us so you are the first to know when new features and templates are launched: + +- [Subscribe to the _#announcement_ channel on Discord](https://discord.gg/z8wNYzb) +- [Follow us on Twitter](https://twitter.com/GetResearchDev) +- [Subscribe to the Hugo Blox blog](https://hugoblox.com/blog/) + +## Further Resources + +- [Hugo Forums](https://discourse.gohugo.io/) for help installing Hugo and resolving Hugo error messages diff --git a/site/content/docs/_index.md b/site/content/docs/_index.md new file mode 100644 index 0000000..ea98d22 --- /dev/null +++ b/site/content/docs/_index.md @@ -0,0 +1,16 @@ +--- +linkTitle: Documentation +title: Introduction +--- + +👋 Welcome to the demo of the Hugo Blox Documentation template! + + + +This site is a demo of the Hugo Blox Documentation theme. For the full documentation on how to use this template, refer to the [Hugo Blox Documentation](https://docs.hugoblox.com/). + +## Next + +{{< cards >}} + {{< card url="getting-started" title="Get Started" icon="document-text" subtitle="Create your docs in just 5 minutes!" >}} +{{< /cards >}} diff --git a/site/content/docs/overview/_index.md b/site/content/docs/overview/_index.md new file mode 100644 index 0000000..e55a408 --- /dev/null +++ b/site/content/docs/overview/_index.md @@ -0,0 +1,11 @@ +--- +title: Overview +weight: 1 +sidebar: + open: true +--- + +{{< cards >}} + {{< card url="project-structure" title="Project Structure" icon="document-duplicate" >}} + {{< card url="configuration" title="Configuration" icon="adjustments-vertical" >}} +{{< /cards >}} diff --git a/site/content/docs/overview/examples/_index.md b/site/content/docs/overview/examples/_index.md new file mode 100644 index 0000000..17e1f62 --- /dev/null +++ b/site/content/docs/overview/examples/_index.md @@ -0,0 +1,12 @@ +--- +title: Examples +--- + +Build the best docs with re-usable components, referred to as Hugo shortcodes: + +{{< cards >}} + {{< card url="callout" title="Callout" icon="warning" >}} + {{< card url="cards" title="Cards" icon="card" >}} + {{< card url="toggle" title="Spoiler" icon="chevron-right" >}} + {{< card url="steps" title="Steps" icon="one" >}} +{{< /cards >}} diff --git a/site/content/docs/overview/examples/callout.md b/site/content/docs/overview/examples/callout.md new file mode 100644 index 0000000..7ce7a93 --- /dev/null +++ b/site/content/docs/overview/examples/callout.md @@ -0,0 +1,36 @@ +--- +title: Callout Shortcode +linkTitle: Callout +--- + +Hugo Blox supports a Markdown extension for callouts, also referred to as alerts or asides. + +Callouts are a useful feature to draw attention to important or related content such as notes, hints, or warnings in your articles. + + + +## Usage + +### Notes + +{{% callout note %}} +A Markdown callout is useful for displaying notices, hints, or definitions to your readers. +{{% /callout %}} + +```markdown +{{%/* callout note */%}} +A Markdown callout is useful for displaying notices, hints, or definitions to your readers. +{{%/* /callout */%}} +``` + +### Warnings + +{{% callout warning %}} +Here's some important information... +{{% /callout %}} + +```markdown +{{%/* callout warning */%}} +Here's some important information... +{{%/* /callout */%}} +``` diff --git a/site/content/docs/overview/examples/cards.md b/site/content/docs/overview/examples/cards.md new file mode 100644 index 0000000..96ecd95 --- /dev/null +++ b/site/content/docs/overview/examples/cards.md @@ -0,0 +1,31 @@ +--- +title: Cards Shortcode +linkTitle: Cards +--- + +A Hugo extension to create cards. Cards can be shown as links or as plain text. + +## Usage + +{{< cards >}} + {{< card url="../" title="Learn Shortcodes" icon="academic-cap" >}} + {{< card url="" title="A card without an icon or link" >}} +{{< /cards >}} + +is rendered by: + +``` +{{}} + {{}} + {{}} +{{}} +``` + +## Options + +| Parameter | Description | +|------------|------------------------------------------------------------------------| +| `icon` | Name of the icon. Defaults to [Hero Icon Pack](https://heroicons.com/) | +| `title` | Title heading for the card. | +| `subtitle` | Subtitle heading (supports Markdown). | +| `url` | URL | diff --git a/site/content/docs/overview/examples/steps.md b/site/content/docs/overview/examples/steps.md new file mode 100644 index 0000000..254981c --- /dev/null +++ b/site/content/docs/overview/examples/steps.md @@ -0,0 +1,47 @@ +--- +title: Steps Shortcode +linkTitle: Steps +--- + +Display a series of steps, such as for a tutorial. + +## Example + +{{% steps %}} + +### Step 1 + +The first step here... + +### Step 2 + +The second step here... + +### Step 3 + +The third step here... + +{{% /steps %}} + + +## Usage + +Use the Markdown level-3 headings to represent step titles within the `steps` shortcode: + +``` +{{%/* steps */%}} + +### Step 1 + +The first step here... + +### Step 2 + +The second step here... + +### Step 3 + +The third step here... + +{{%/* /steps */%}} +``` diff --git a/site/content/docs/overview/examples/toggle.md b/site/content/docs/overview/examples/toggle.md new file mode 100644 index 0000000..a459a9f --- /dev/null +++ b/site/content/docs/overview/examples/toggle.md @@ -0,0 +1,27 @@ +--- +title: Spoiler +--- + +A Hugo shortcode to toggle collapsible content. + + + +## Example + +{{< spoiler text="Click to view the spoiler" >}} +You found me! + +Markdown is **supported**. +{{< /spoiler >}} + +## Usage + +```` +{{}} + +This is the content of the details. + +Markdown is **supported**. + +{{}} +```` diff --git a/site/content/docs/overview/getting-started.md b/site/content/docs/overview/getting-started.md new file mode 100644 index 0000000..c5292e3 --- /dev/null +++ b/site/content/docs/overview/getting-started.md @@ -0,0 +1,36 @@ +--- +title: Getting Started +date: 2024-02-17 +weight: 10 +--- + +## Quick Start from Template + +{{% steps %}} + +### Initialize a new site + +[Click to copy the template on GitHub](https://github.com/new?template_name=theme-documentation&template_owner=HugoBlox) + +### Configure your new site + +[Configure your site name, description, and menu.](https://docs.hugoblox.com/tutorial/blog/) + +### Add your content + +[Edit the homepage and add your documentation pages.](https://docs.hugoblox.com/tutorial/blog/) + +### Publish your site + +[Easily publish your site for free with GitHub Pages](https://docs.hugoblox.com/tutorial/blog/) + +{{% /steps %}} + +## Next + +Let's customize your new site: + +{{< cards >}} + {{< card url="../guide/project-structure" title="Project Structure" icon="document-duplicate" >}} + {{< card url="../guide/configuration" title="Configuration" icon="adjustments-vertical" >}} +{{< /cards >}} diff --git a/site/content/docs/overview/install.md b/site/content/docs/overview/install.md new file mode 100644 index 0000000..2653db0 --- /dev/null +++ b/site/content/docs/overview/install.md @@ -0,0 +1,59 @@ +--- +title: Installing Codemetrica +weight: 20 +--- + +## Folder Structure + +There are **4 main folders for Hugo-based sites**: + +- `content/` for your Markdown-formatted content files (homepage, etc.) + - `_index.md` the homepage (**Hugo requires that the homepage and archive pages have an underscore prefix**) +- `assets/` + - `media/` for your media files (images, videos) + - `icons/custom/` upload any custom SVG icons you want to use +- `config/_default/` for your site configuration files + - `hugo.yaml` to configure Hugo (site title, URL, Hugo options, setup per-folder page features) + - `module.yaml` to install or uninstall Hugo themes and plugins + - `params.yaml` to configure Hugo Blox options (SEO, analytics, site features) + - `menus.yaml` to configure your menu links (if the menu is enabled in `params.yaml`) + - `languages.yaml` to configure your site's language or to set language-specific options in a multilingual site +- `static/uploads/` for any files you want visitors to download, such as a PDF +- `go.mod` sets the version of Hugo themes/plugins which your site uses + + +## Hugo File Naming Convention + +Hugo gives us two options to name standard page files: as `TITLE/index.md` or `TITLE.md` where `TITLE` is your page name. + +The page name should be lowercase and using hyphens (`-`) instead of spaces. + +Both approaches result in the same output, so you can choose your preferred approach to naming and organizing files. A benefit to the folder-based approach is that all your page's files (such as images) are self-contained within the page's folder, so it's more portable if you wish to share the original Markdown page with someone. + +The homepage is a special case as **Hugo requires the homepage and listing pages to be named** `_index.md`. + +## Docs Navigation + +The docs navigation is automatically generated based on the content in the `docs/` folder and is sorted alphabetically. + +The order of pages can be changed by adding the `weight` parameter in the front matter of your Markdown files. + +In the example below, the `example.md` page will appear before the `test.md` page as it has a lower `weight`: + +Page `example.md`: + +```yaml +--- +title: My Example +weight: 1 +--- +``` + +Page `test.md`: + +```yaml +--- +title: My Test +weight: 2 +--- +``` diff --git a/site/content/docs/supported-features/_index.md b/site/content/docs/supported-features/_index.md new file mode 100644 index 0000000..53d0f6b --- /dev/null +++ b/site/content/docs/supported-features/_index.md @@ -0,0 +1,7 @@ +--- +linkTitle: Supported Features +title: Supported Features +weight: 20 +--- + +You can learn more about different metrics and code smells from the following resources. \ No newline at end of file diff --git a/site/content/docs/supported-features/code-smells.md b/site/content/docs/supported-features/code-smells.md new file mode 100644 index 0000000..f3b44ef --- /dev/null +++ b/site/content/docs/supported-features/code-smells.md @@ -0,0 +1,57 @@ +--- +title: Code Smells +weight: 20 +toc: false +--- + +## General Smells + +| Smell | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| -------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :-------------------------: | :--: | :--------: | +| BrokenModularization | - | - | - | - | - | - | - | - | - | +| Complex Conditional | - | - | - | - | - | - | ✅ | - | - | +| DeficientEncapsulation | - | - | - | - | - | - | - | - | - | +| Dispersed Coupling | - | - | - | - | - | - | - | - | - | +| Empty catch clause | - | - | - | - | - | - | 🟡 | - | - | +| HubLikeModularization | - | - | - | - | - | - | - | - | - | +| ImperativeAbstraction | - | - | - | - | - | - | - | - | - | +| InsufficientModularization | - | - | - | - | - | - | - | - | - | +| Intensive Coupling | - | - | - | - | - | - | - | - | - | +| Long Identifier | - | - | - | - | - | - | ✅ | - | - | +| Long Statement | - | - | - | - | - | - | ✅ | - | - | +| Magic Number | - | - | - | - | - | - | 🟡 | - | - | +| Message Chain | - | - | - | - | - | - | 🟡 | - | - | +| Missing default | - | - | - | - | - | - | ✅ | - | - | +| MultifacetedAbstraction | - | - | - | - | - | - | 🟡 | - | - | +| Refused Bequest | - | - | - | - | - | - | OverrideRatio > 0.5 | - | - | +| Shotgun Surgery | - | - | - | - | - | - | - | - | - | +| Spaghetti Code | - | - | - | - | - | - | - | - | - | +| Speculative Generality | - | - | - | - | - | - | IsAbstractChildrenCount < 3 | - | - | +| Swiss Army Knife | - | - | - | - | - | - | 🟡 | - | - | +| UnexploitedEncapsulation | - | - | - | - | - | - | - | - | - | +| UnnecessaryAbstraction | - | - | - | - | - | - | 🟡 | - | - | +| UnutilizedAbstraction | - | - | - | - | - | - | - | - | - | + + +## Class Level Smells + +| Smell | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| ---------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Brain Class | - | - | - | - | _ | - | - | - | - | +| Class Data Should Be Private | - | - | - | - | _ | - | - | - | - | +| Complex Class | - | - | - | - | _ | - | 🟡 | - | - | +| Data Class | - | - | - | - | _ | - | 🟡 | - | - | +| God Class | - | - | - | - | _ | - | 🟡 | - | - | +| Large Class | - | - | - | - | _ | - | 🟡 | - | - | +| Lazy Class | - | - | - | - | _ | - | ✅ | - | - | + + +## Method Level Smells + +| Smell | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| --------------------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Abstract Function Call From Constructor | - | - | - | - | - | - | - | - | - | +| Brain Method | - | - | - | - | - | - | - | - | - | +| Complex Method | - | - | - | - | - | - | ✅ | - | - | +| Long Method | - | - | - | - | ✅ | - | ✅ | - | - | +| Long Parameter List | - | - | - | - | - | - | ✅ | - | - | diff --git a/site/content/docs/supported-features/energy-smells.md b/site/content/docs/supported-features/energy-smells.md new file mode 100644 index 0000000..4dc4557 --- /dev/null +++ b/site/content/docs/supported-features/energy-smells.md @@ -0,0 +1,6 @@ +--- +title: Energy Smells +weight: 40 +--- + +## Coming soon! \ No newline at end of file diff --git a/site/content/docs/supported-features/metrics.md b/site/content/docs/supported-features/metrics.md new file mode 100644 index 0000000..521f069 --- /dev/null +++ b/site/content/docs/supported-features/metrics.md @@ -0,0 +1,54 @@ +--- +title: Metrics +weight: 10 +--- + +## Size Metrics + +| Metrics | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| ------------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Lines of Code (LOC) | - | - | - | - | _ | - | ✅ | - | - | +| Source Lines of Code (SLOC) | - | - | - | - | _ | - | - | - | - | +| Kilo Lines of Code (KLOC) | - | - | - | - | _ | - | - | - | - | +| Comment Lines of Code (CLOC) | - | - | - | - | _ | - | - | - | - | +| Number of Methods (NOM) | - | - | - | - | _ | - | - | - | - | +| Number of Classes (NOC) | - | - | - | - | _ | - | - | - | - | +| Number of Fields (NOF) | - | - | - | - | _ | - | - | - | - | +| Number of Public Methods (NOPM) | - | - | - | - | _ | - | - | - | - | + +## Complexity Metrics + +| Metrics | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| -------------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Cyclomatic Complexity (CC) | - | - | - | - | _ | - | ✅ | - | - | +| Weighted Methods per Class (WMC) | - | - | - | - | _ | - | - | - | - | +| NPath Complexity | - | - | - | - | _ | - | - | - | - | +| Essential Complexity | - | - | - | - | _ | - | - | - | - | +| Halstead Volume | - | - | - | - | _ | - | - | - | - | +| Halstead Difficulty | - | - | - | - | _ | - | - | - | - | +| Halstead Effort | - | - | - | - | _ | - | - | - | - | +| Nested Block Depth (NBD) | - | - | - | - | _ | - | - | - | - | +| Decision Density | - | - | - | - | _ | - | - | - | - | + + +## Object-Oriented Metrics + +| Metrics | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| ---------------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Depth of Inheritance Tree (DIT) | - | - | - | - | _ | - | - | - | - | +| NOC Number of Children (NOC) | - | - | - | - | _ | - | - | - | - | +| Response for a Class (RFC) | - | - | - | - | _ | - | - | - | - | +| Coupling Between Objects (CBO) | - | - | - | - | _ | - | - | - | - | +| Lack of Cohesion of Methods (LCOM) | - | - | - | - | _ | - | - | - | - | +| LCOM5 | - | - | - | - | _ | - | - | - | - | +| Cohesion Metric | - | - | - | - | _ | - | - | - | - | +| Polymorphism Factor (PF) | - | - | - | - | _ | - | - | - | - | +| Method Inheritance Factor (MIF) | - | - | - | - | _ | - | - | - | - | +| Attribute Inheritance Factor (AIF) | - | - | - | - | _ | - | - | - | - | + +## Maintainability Metrics + +| Metrics | C | C++ | C# | Go | Java | PHP | Python | Rust | TypeScript | +| ------------------------- | :-: | :-: | :-: | :-: | :--: | :-: | :----: | :--: | :--------: | +| Lack of Cohesive Comments | - | - | - | - | _ | - | - | - | - | +| Duplicate Comments | - | - | - | - | _ | - | - | - | - | \ No newline at end of file diff --git a/site/content/docs/supported-features/test-smells.md b/site/content/docs/supported-features/test-smells.md new file mode 100644 index 0000000..02a44a5 --- /dev/null +++ b/site/content/docs/supported-features/test-smells.md @@ -0,0 +1,6 @@ +--- +title: Test Smells +weight: 30 +--- + +## Coming soon! \ No newline at end of file diff --git a/site/content/knowledge-hub/_index.md b/site/content/knowledge-hub/_index.md new file mode 100644 index 0000000..f4fe98c --- /dev/null +++ b/site/content/knowledge-hub/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: Knowledge Hub +title: Knowledge Hub +weight: 30 +pager: false +--- + +You can learn more about different metrics and code smells from the following resources. \ No newline at end of file diff --git a/site/content/knowledge-hub/code-smell.md b/site/content/knowledge-hub/code-smell.md new file mode 100644 index 0000000..2222a99 --- /dev/null +++ b/site/content/knowledge-hub/code-smell.md @@ -0,0 +1,6 @@ +--- +title: Code Smell +weight: 10 +--- + +## Coming soon! diff --git a/site/content/knowledge-hub/external-resources.md b/site/content/knowledge-hub/external-resources.md new file mode 100644 index 0000000..aef8bd5 --- /dev/null +++ b/site/content/knowledge-hub/external-resources.md @@ -0,0 +1,10 @@ +--- +title: External resources +linkTitle: External resources +weight: 20 +--- + +## Code Smells + +* https://github.com/luzkan/smells +* https://github.com/tushartushar/smells diff --git a/site/content/showcase/_index.md b/site/content/showcase/_index.md new file mode 100644 index 0000000..dc1a31c --- /dev/null +++ b/site/content/showcase/_index.md @@ -0,0 +1,34 @@ +--- +title: Showcase +description: "Docs websites powered by Hugo Blox." +type: landing + + + +sections: + - block: hero + content: + title: Get Inspirated + text: 'Get inspired by exploring sites #MadeWithHugoBlox' + primary_action: + icon: brands/x + text: Submit Your Site + url: "https://twitter.com/intent/tweet?text=I%27m%20creating%20a%20beautiful%20website%20using%20the%20free%20%E2%9D%A4%EF%B8%8F%2C%20open%20source%20Hugo%20Blox%20Website%20Builder%20for%20%40GoHugoIO%20by%20%40GeorgeCushen%20%40GetResearchDev%20%E2%9C%A8%20Have%20some%20feedback%3F%20Please%20comment%20%F0%9F%A4%97&hashtags=MadeWithHugoBlox&url=https://HugoBlox.com/" + secondary_action: + text: Explore More on HugoBlox.com + url: https://hugoblox.com/creators/ + design: + no_padding: true + spacing: + padding: [0, 0, 0, 0] + margin: [0, 0, 0, 0] + - block: collection + content: + filters: + folders: + - showcase + design: + view: card + spacing: + padding: ['3rem', 0, '6rem', 0] +--- diff --git a/site/content/showcase/nvidia/featured.webp b/site/content/showcase/nvidia/featured.webp new file mode 100644 index 0000000..e257daa Binary files /dev/null and b/site/content/showcase/nvidia/featured.webp differ diff --git a/site/content/showcase/nvidia/index.md b/site/content/showcase/nvidia/index.md new file mode 100644 index 0000000..bfa17a2 --- /dev/null +++ b/site/content/showcase/nvidia/index.md @@ -0,0 +1,6 @@ +--- +title: Nvidia +summary: nvidia.com +external_link: https://research.nvidia.com/labs/toronto-ai/ +date: 2024-02-17 +--- diff --git a/site/go.mod b/site/go.mod new file mode 100644 index 0000000..ef809ac --- /dev/null +++ b/site/go.mod @@ -0,0 +1,8 @@ +module github.com/HugoBlox/theme-documentation + +go 1.15 + +require ( + github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20240217212918-ae7f0c597978 + github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20241012174104-661cadc17327 +) diff --git a/site/go.sum b/site/go.sum new file mode 100644 index 0000000..9edd35f --- /dev/null +++ b/site/go.sum @@ -0,0 +1,5 @@ +github.com/HugoBlox/hugo-blox-builder/modules/blox-analytics v0.1.3/go.mod h1:0YQtVvRLCzZOpPmbVNk7WDx8t19/QfRTFO+pwyqQNk8= +github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20240217212918-ae7f0c597978 h1:AMsITVwNWp5CR/OxnYEsXT6hxZJfD+XycPArm9jJUDk= +github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20240217212918-ae7f0c597978/go.mod h1:C7jfxMLv1bEUqbM9XDSmEpfOpS8w06OgqNDEcbuRgL4= +github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20241012174104-661cadc17327 h1:5P+3GBud67lEhxVevV2UbAZccMBMZnmsmSpP1amosXM= +github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20241012174104-661cadc17327/go.mod h1:bUQKSt1XQhk60nSpI6D+MibQi6v8s7HghF5qoAtlhws= diff --git a/site/hugo-blox/blox/all-access/README.md b/site/hugo-blox/blox/all-access/README.md new file mode 100644 index 0000000..42cbda7 --- /dev/null +++ b/site/hugo-blox/blox/all-access/README.md @@ -0,0 +1,7 @@ +# Hugo Blox Builder: All Access + +Elevate your web projects with [All Access](https://hugoblox.com/sponsor/), our premium Tailwind blox collection! + +Get access to a diverse range of professionally designed, responsive components — from sleek pricing sections to interactive forms. Save time with our ready-to-use blox, fully customizable to fit your brand, and focus on creating unique features that set your website apart. Optimize your development process and enhance your designs effortlessly with our Tailwind blox! + +Upload All Access blox to this folder and they will be automatically installed to your site, [ready for use in your pages](https://docs.hugoblox.com/getting-started/page-builder/). diff --git a/site/hugo-blox/blox/community/README.md b/site/hugo-blox/blox/community/README.md new file mode 100644 index 0000000..f77979b --- /dev/null +++ b/site/hugo-blox/blox/community/README.md @@ -0,0 +1,5 @@ +# Hugo Blox Builder: Community Blox + +Upload custom or community Hugo Blox to this folder and they will be automatically installed to your site, [ready for use in your pages](https://docs.hugoblox.com/getting-started/page-builder/). + +Creating your own blox? [Follow the step-by-step tutorial](https://docs.hugoblox.com/getting-started/page-builder/). diff --git a/site/hugo_stats.json b/site/hugo_stats.json new file mode 100644 index 0000000..368c97e --- /dev/null +++ b/site/hugo_stats.json @@ -0,0 +1,547 @@ +{ + "htmlElements": { + "tags": [ + "?xml", + "a", + "article", + "aside", + "body", + "button", + "circle", + "code", + "defs", + "desc", + "details", + "div", + "em", + "footer", + "g", + "h1", + "h2", + "h3", + "head", + "header", + "hr", + "html", + "img", + "input", + "label", + "li", + "line", + "link", + "main", + "meta", + "nav", + "p", + "path", + "polygon", + "pre", + "rect", + "script", + "section", + "span", + "strong", + "style", + "summary", + "svg", + "table", + "tbody", + "td", + "th", + "thead", + "time", + "title", + "tr", + "ul" + ], + "classes": [ + "!mb-4", + "-inset-x-4", + "-inset-y-6", + "-mr-4", + "[&.active]:font-bold", + "[&.active]:text-black/90", + "[&:not(dark)]:hidden", + "[hyphens:auto]", + "[word-break:break-word]", + "absolute", + "active", + "article-container", + "article-header", + "article-header-caption", + "bg-gray-100", + "bg-neutral-300", + "bg-neutral-50", + "bg-primary-100", + "bg-primary-200", + "bg-primary-600", + "bg-primary-700", + "bg-white", + "bg-yellow-100", + "bg-zinc-50", + "block", + "blox-collection", + "blox-features", + "blox-hero", + "border", + "border-current", + "border-dotted", + "border-gray-100", + "border-neutral-300", + "break-words", + "btn", + "btn-outline-primary", + "chroma", + "container", + "content", + "cursor-default", + "cursor-pointer", + "dark:[&.active]:text-white", + "dark:bg-black/80", + "dark:bg-gray-800", + "dark:bg-hb-dark", + "dark:bg-neutral-700", + "dark:bg-neutral-800", + "dark:bg-primary-300", + "dark:bg-primary-600", + "dark:bg-primary-900", + "dark:bg-yellow-900", + "dark:bg-zinc-800/50", + "dark:bg-zinc-900", + "dark:block", + "dark:border-gray-700", + "dark:border-neutral-600", + "dark:focus:ring-primary-800", + "dark:group-hover:text-primary-400", + "dark:hidden", + "dark:hover:bg-gray-100/5", + "dark:hover:bg-primary-400", + "dark:hover:bg-primary-700", + "dark:hover:bg-primary-800", + "dark:hover:ring-gray-400", + "dark:hover:text-gray-100", + "dark:hover:text-gray-300", + "dark:hover:text-gray-50", + "dark:hover:text-neutral-800", + "dark:hover:text-primary-300", + "dark:hover:text-primary-400", + "dark:prose-invert", + "dark:ring-gray-300", + "dark:text-gray-100", + "dark:text-gray-300", + "dark:text-gray-400", + "dark:text-neutral", + "dark:text-neutral-300", + "dark:text-neutral-400", + "dark:text-primary-200", + "dark:text-primary-300", + "dark:text-primary-900", + "dark:text-slate-100", + "dark:text-slate-200", + "dark:text-white", + "dark:text-zinc-100", + "dark:text-zinc-400", + "dark:text-zinc-500", + "duration-500", + "featured-image", + "featured-image-wrapper", + "fill-current", + "first:mt-0", + "fixed", + "flex", + "flex-col", + "flex-nowrap", + "flex-row", + "flex-wrap", + "focus-visible:outline", + "focus-visible:outline-2", + "focus-visible:outline-offset-2", + "focus-visible:outline-primary-600", + "focus:outline-none", + "focus:ring-4", + "focus:ring-primary-300", + "font-bold", + "font-extrabold", + "font-medium", + "font-semibold", + "gap-1", + "gap-4", + "gap-5", + "gap-6", + "gap-x-1.5", + "gap-x-6", + "gap-y-2", + "grid", + "group", + "group-hover:-translate-x-[2px]", + "group-hover:decoration-primary-500", + "group-hover:opacity-100", + "group-hover:scale-100", + "group-hover:text-primary-600", + "group-hover:underline", + "h-0", + "h-10", + "h-100", + "h-24", + "h-4", + "h-48", + "h-5", + "h-6", + "h-[18px]", + "hb-card", + "hb-card-subtitle", + "hb-card-title", + "hb-cards", + "hb-docs-link", + "hb-scrollbar", + "hb-sidebar-container", + "hb-sidebar-custom-link", + "hb-sidebar-list", + "hb-sidebar-mobile-menu", + "hb-sidebar-mobile-toc", + "hb-steps", + "hb-toc", + "hbb-section", + "header", + "hidden", + "highlight", + "home-section-bg", + "hover:bg-gray-100", + "hover:bg-gray-800/5", + "hover:bg-primary-300", + "hover:bg-primary-500", + "hover:bg-primary-800", + "hover:dark:text-gray-200", + "hover:ring-gray-900/20", + "hover:scale-125", + "hover:text-gray-800", + "hover:text-gray-900", + "hover:text-neutral-300", + "hover:text-primary", + "hover:text-primary-700", + "inline-block", + "inline-flex", + "inset-0", + "isolate", + "items-center", + "items-start", + "justify-between", + "justify-center", + "justify-items-center", + "justify-left", + "leading-3", + "leading-6", + "leading-8", + "leading-tight", + "lg:flex", + "lg:grid-cols-3", + "lg:h-12", + "lg:h-6", + "lg:h-[calc(100vh-var(--navbar-height))]", + "lg:hidden", + "lg:mb-16", + "lg:ml-0", + "lg:order-1", + "lg:pb-0", + "lg:prose-xl", + "lg:px-5", + "lg:px-6", + "lg:px-8", + "lg:py-2", + "lg:py-56", + "lg:space-x-2", + "lg:sticky", + "lg:text-6xl", + "lg:w-12", + "lg:w-6", + "lg:w-auto", + "ltr:inline", + "ltr:pr-0", + "ltr:text-right", + "m-1", + "max-h-[calc(100vh-var(--navbar-height)-env(safe-area-inset-bottom))]", + "max-lg:[transform:translate3d(0,-100%,0)]", + "max-lg:hidden", + "max-w-2xl", + "max-w-3xl", + "max-w-6xl", + "max-w-[65ch]", + "max-w-none", + "max-w-prose", + "max-w-screen-md", + "max-w-screen-xl", + "max-xl:hidden", + "mb-1", + "mb-16", + "mb-2", + "mb-3", + "mb-4", + "mb-5", + "mb-6", + "mb-8", + "md:block", + "md:col-span-3", + "md:flex", + "md:flex-row", + "md:flex-shrink-0", + "md:gap-12", + "md:grid", + "md:grid-cols-2", + "md:grid-cols-4", + "md:hidden", + "md:items-baseline", + "md:order-2", + "md:px-12", + "md:space-y-0", + "md:w-48", + "me-2", + "min-h-[calc(100vh-var(--navbar-height))]", + "min-w-0", + "min-w-[18px]", + "min-w-[24px]", + "ml-1", + "ml-auto", + "mr-1", + "mr-2", + "mr-4", + "ms-2", + "mt-1", + "mt-1.5", + "mt-10", + "mt-12", + "mt-16", + "mt-2", + "mt-24", + "mt-3", + "mt-4", + "mt-5", + "mt-6", + "mt-[-0.3rem]", + "mt-[0.1rem]", + "mx-1", + "mx-auto", + "my-1", + "my-10", + "my-2", + "my-5", + "nav-item", + "nav-link", + "navbar", + "navbar-brand", + "navbar-nav", + "no-prose", + "no-underline", + "not-prose", + "object-cover", + "opacity-0", + "open", + "order-0", + "order-1", + "order-3", + "order-first", + "order-last", + "origin-center", + "overflow-hidden", + "overflow-y-auto", + "p-0.5", + "p-1.5", + "p-2", + "p-3", + "p-4", + "p-8", + "page-body", + "page-footer", + "page-header", + "page-wrapper", + "pb-4", + "pb-6", + "pb-8", + "pl-1", + "pl-2", + "pl-4", + "place-self-center", + "powered-by", + "pr-2", + "pr-3", + "pr-4", + "pr-[calc(env(safe-area-inset-right)-1.5rem)]", + "print:hidden", + "prose", + "prose-slate", + "pt-1", + "pt-12", + "pt-14", + "pt-2", + "pt-4", + "pt-6", + "px-2", + "px-2.5", + "px-3", + "px-3.5", + "px-4", + "px-5", + "px-6", + "py-0.5", + "py-1", + "py-1.5", + "py-2.5", + "py-3", + "py-32", + "py-8", + "relative", + "ring-1", + "ring-gray-900/10", + "rounded", + "rounded-full", + "rounded-lg", + "rounded-md", + "rounded-sm", + "rounded-xl", + "rtl:-ml-4", + "rtl:-rotate-180", + "rtl:hidden", + "rtl:pr-4", + "rtl:text-left", + "scale-95", + "scroll-my-6", + "scroll-py-6", + "shadow-md", + "shadow-sm", + "shrink-0", + "sidebar-active-item", + "sm:-inset-x-6", + "sm:flex", + "sm:justify-center", + "sm:mb-8", + "sm:mt-20", + "sm:py-16", + "sm:py-48", + "sm:rounded-2xl", + "sm:text-6xl", + "sm:text-lg", + "sm:text-xl", + "space-y-16", + "space-y-8", + "spoiler", + "sticky", + "stroke-current", + "text-2xl", + "text-4xl", + "text-[0.6rem]", + "text-base", + "text-black", + "text-center", + "text-current", + "text-dark", + "text-ellipsis", + "text-gray-500", + "text-gray-600", + "text-gray-700", + "text-gray-900", + "text-lg", + "text-md", + "text-neutral-500", + "text-neutral-700", + "text-neutral-800", + "text-primary-500", + "text-primary-600", + "text-primary-700", + "text-primary-800", + "text-red-400", + "text-right", + "text-slate-700", + "text-slate-900", + "text-sm", + "text-white", + "text-xl", + "text-xs", + "text-zinc-400", + "text-zinc-600", + "text-zinc-800", + "theme-toggle", + "top-0", + "top-16", + "tracking-tight", + "tracking-wide", + "transition", + "transition-colors", + "transition-transform", + "uppercase", + "w-10", + "w-24", + "w-3.5", + "w-4", + "w-5", + "w-64", + "w-fit", + "w-full", + "whitespace-nowrap", + "xl:block", + "xl:space-x-8", + "z-0", + "z-10", + "z-20", + "z-30" + ], + "ids": [ + "58a3b77c-d556-4022-850a-0cb35747347a", + "add-your-content", + "bug-fixes", + "chat", + "class-level-smells", + "code-smells", + "coming-soon", + "complexity-metrics", + "configure-your-new-site", + "d56f0fb8-90ab-45f8-9361-abb48a852b3d", + "docs", + "docs-navigation", + "e3ea256e-5f34-40b3-b351-7977abecf2ab", + "example", + "feature-requests", + "features", + "folder-structure", + "further-resources", + "general-smells", + "hide-button", + "how-to-upgrade", + "hugo-file-naming-convention", + "initialize-a-new-site", + "maintainability-metrics", + "method-level-smells", + "moon", + "nav-menu", + "nav-toggle", + "new-features", + "news", + "next", + "notes", + "object-oriented-metrics", + "options", + "page-bg", + "publish-your-site", + "quick-start-from-template", + "search", + "search_toggle", + "section-collection", + "section-hero", + "share-link-email", + "share-link-facebook", + "share-link-linkedin", + "share-link-whatsapp", + "share-link-x", + "show-button", + "site-header", + "size-metrics", + "spoiler-0", + "step-1", + "step-2", + "step-3", + "sun", + "support", + "top", + "usage", + "warnings" + ] + } +} diff --git a/site/hugoblox.yaml b/site/hugoblox.yaml new file mode 100644 index 0000000..10c576e --- /dev/null +++ b/site/hugoblox.yaml @@ -0,0 +1,2 @@ +build: + hugo_version: '0.135.0' diff --git a/site/static/uploads/.gitkeep b/site/static/uploads/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/site/theme.toml b/site/theme.toml new file mode 100644 index 0000000..83e797a --- /dev/null +++ b/site/theme.toml @@ -0,0 +1,15 @@ +name = "Easy Docs" +license = "MIT" +licenselink = "https://github.com/HugoBlox/theme-documentation/blob/main/LICENSE.md" +description = "Easy, all-in-one beautiful documentation website including a customizable homepage and blog. Super fast, empowering you to focus on your content." + +homepage = "https://github.com/HugoBlox/theme-documentation" +demosite = "https://hugo-docs-theme.netlify.app" + +tags = ["landing", "docs", "blog", "responsive", "minimal", "light", "dark", "multilingual", "dark mode", "tailwind", "company", "gallery"] +features = ["secure", "fast", "search", "dark mode", "widgets"] + +# If the theme has a single author +[author] + name = "George Cushen" + homepage = "https://georgecushen.com/" diff --git a/site/typedoc.md b/site/typedoc.md new file mode 100644 index 0000000..fa2d674 --- /dev/null +++ b/site/typedoc.md @@ -0,0 +1 @@ +API Docs page \ No newline at end of file diff --git a/typedoc.json b/typedoc.json index 91b8f59..6a5e919 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "$schema": "https://typedoc.org/schema.json", - "name": "CodeMetrica", + "name": "Codemetrica", // "projectDocuments": ["docs/*"], "entryPoints": [ "./codemetrica/index.ts", @@ -17,16 +17,15 @@ // "./*.ts", "./*.json", ], - "out": "website", - "customFooterHtml": "

Copyright CodeMetrica 2024

", + "out": "site/static/api/", + "customFooterHtml": "

© CodeMetrica 2024

", "navigationLinks": { - "Docs": "http://example.com", - "Example": "http://example.com", - "API": "http://example.com", + "Docs": "/docs/", + "Example": "/docs/overview/examples/", "GitHub": "https://github.com/sparklabOrg/codemetrica" }, "sidebarLinks": { - "Example": "http://example.com" + "Back to docs": "/docs/", }, "navigation": { // "includeCategories": true, @@ -40,5 +39,5 @@ // "plugin": ["typedoc-plugin-rename-defaults"], // "theme": "hierarchy", // "excludeNotExported": false - "readme": "./docs/CodeMetrica.md", + "readme": "./site/typedoc.md", } \ No newline at end of file