Skip to content

refactor: switch to Astro #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 21 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
dd98900
refactor(*): switch to astro for static site builds of sassdoc
simeonoff Apr 10, 2025
dcdb30b
refactor: many changes and additions
simeonoff Apr 24, 2025
aade1ef
i18n: add some localication strings
simeonoff Apr 25, 2025
d98088d
refactor(i18n): improve localization logic and strings
simeonoff Apr 25, 2025
4bfa49d
refactor(*): minor fixes and improvements
simeonoff Apr 25, 2025
6ef6880
ci: update github scripts
simeonoff Apr 25, 2025
f7389e1
npm(package-lock.json): bump
simeonoff Apr 25, 2025
ee5da8f
feat: add headers and footers
simeonoff May 8, 2025
e197563
fix(i18n): language not buing applied
simeonoff May 8, 2025
f6f0596
refactor: remove bulgarian from languages
simeonoff May 8, 2025
ee55fca
fix(item-header): hash link doesn't work
simeonoff May 8, 2025
08b3ff3
refactor(*): make sassdoc-schema the only source of truth for types
simeonoff May 9, 2025
b7a1ec2
refactor(MainLayout): add missing cannonical links
simeonoff May 12, 2025
5283bb7
refactor(*): simplify structure
simeonoff May 12, 2025
4a661c5
refactor(index): improve layout and content
simeonoff May 13, 2025
761f43b
fix(references): groups overflow
simeonoff May 13, 2025
6ab8b12
fix(utils): properly handle items with custom names
simeonoff May 16, 2025
fb47307
chore: improve Google Tag Manager implementation and HTML structure
simeonoff May 19, 2025
7948f6f
ci: update working directory paths for npm publish workflow
simeonoff May 19, 2025
2cb5f1c
ci: simplify npm tag definition in workflow
simeonoff May 19, 2025
ec8e089
feat(i18n): implement header translations and optimize search metadata
simeonoff May 21, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .browserlistrc

This file was deleted.

31 changes: 31 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]

# Change these settings to your own preference
indent_style = space
indent_size = 2

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[*.json]
indent_size = 2

[*.{html,js,md}]
block_comment_start = /**
block_comment = *
block_comment_end = */

[*.scss]
indent_size = 4
7 changes: 3 additions & 4 deletions .github/workflows/npm-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,16 @@ on:

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x]
node-version: [22.x]

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
Expand Down
22 changes: 10 additions & 12 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages

name: Node.js Deploy

on:
Expand All @@ -11,10 +8,10 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: 22
cache: 'npm'
registry-url: 'https://registry.npmjs.org'

Expand All @@ -27,16 +24,17 @@ jobs:
- name: Build package
run: npm run build

- name: Define NPM tag
run: if [[ ${VERSION} == *"alpha"* || ${VERSION} == *"beta"* || ${VERSION} == *"rc"* ]]; then echo "NPM_TAG=next"; else echo "NPM_TAG=latest"; fi >> $GITHUB_ENV
- run: echo ${NPM_TAG}
- name: Define npm tag
run: |
if [[ ${VERSION} == *"alpha"* || ${VERSION} == *"beta"* || ${VERSION} == *"rc"* ]]; then echo "NPM_TAG=next"; else echo "NPM_TAG=latest"; fi >> $GITHUB_ENV
echo ${NPM_TAG}

- name: Create package version
run: npm version ${VERSION} --no-git-tag-version --save --allow-same-version --verbose
working-directory: ./
working-directory: dist

- name: Publish igniteui-sassdoc-theme
run: npm publish --tag ${NPM_TAG}
working-directory: ./
env:
working-directory: dist
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
22 changes: 6 additions & 16 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.DS_Store

# Runtime data
pids
Expand All @@ -17,15 +18,6 @@ lib-cov
# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

Expand All @@ -36,11 +28,12 @@ build/Release
/dist
/tmp
/out-tsc

/site
/public
/data

# Dependency directories
/node_modules/
/jspm_packages/

# IDE - VSCode/VS
.vscode/*
Expand All @@ -50,9 +43,6 @@ build/Release
!.vscode/launch.json
!.vscode/extensions.json

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

Expand All @@ -71,5 +61,5 @@ typings/
# dotenv environment variables file
.env

# next.js build output
.next
# astro build output
.astro
4 changes: 0 additions & 4 deletions .jshintrc

This file was deleted.

11 changes: 11 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": "*.astro",
"options": {
"parser": "astro"
}
}
]
}
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2019 INFRAGISTICS.
Copyright 2025 INFRAGISTICS.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction,
Expand Down
43 changes: 43 additions & 0 deletions astro.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { defineConfig } from "astro/config";
import expressiveCode from "astro-expressive-code";
import pagefind from "astro-pagefind";

export default defineConfig({
output: "static",
outDir: "./site",
build: {
assets: "_assets",
format: "file",
},
integrations: [
expressiveCode({
themes: ["github-light"],
styleOverrides: {
borderRadius: "0",
borderWidth: "1px",
borderColor: "var(--ig-gray-300)",
frames: {
shadowColor: "none",
},
},
shiki: {
bundledLangs: ["scss", "html"],
engine: "oniguruma",
},
defaultProps: {
wrap: true,
},
}),
pagefind(),
],
vite: {
css: {
preprocessorOptions: {
scss: {
quietDeps: true,
loadPaths: ["./node_modules/"],
},
},
},
},
});
Loading