Skip to content

Commit

Permalink
refactor: Updated docs to use node 20 & a new sitemap plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
khalwat committed Jan 14, 2024
1 parent 0bd056b commit ebf2ab1
Show file tree
Hide file tree
Showing 7 changed files with 2,935 additions and 1,590 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build-and-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
strategy:
fail-fast: true
matrix:
node-version: [ 14.x ]
node-version: [ 20.x ]
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
Expand Down
4 changes: 2 additions & 2 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ARG TAG=14-alpine
ARG TAG=20-alpine
FROM node:$TAG

USER node
RUN npm install -g npm@^10.0.0

WORKDIR /app/

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
MAJOR_VERSION?=4
TAG?=14-alpine
TAG?=20-alpine
CONTAINER?=$(shell basename $(dir $(CURDIR)))-v${MAJOR_VERSION}-docs
DOCS_DEV_PORT?=400${MAJOR_VERSION}
DOCS_DEST?=../../../sites/nystudio107/web/docs/image-optimize
Expand Down
1 change: 0 additions & 1 deletion docs/docs/@types/sitemap-plugin.d.ts

This file was deleted.

19 changes: 9 additions & 10 deletions docs/docs/vite.config.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
import {defineConfig} from 'vite'
import SitemapPlugin from 'rollup-plugin-sitemap'
import { sitemap, Url as SitemapUrl } from '@aminnairi/rollup-plugin-sitemap'
import VitePressConfig from './.vitepress/config'
import {DefaultTheme} from "vitepress/types/default-theme";

const docsSiteBaseUrl = 'https://nystudio107.com'
const docsBaseUrl = new URL(VitePressConfig.base!, docsSiteBaseUrl).href.replace(/\/$/, '') + '/';
let siteMapRoutes: SiteMapPluginUrls = [];
let siteMapUrls: SitemapUrl[] = [];
if (Array.isArray(VitePressConfig.themeConfig?.sidebar)) {
siteMapRoutes = VitePressConfig.themeConfig?.sidebar?.map((group: DefaultTheme.SidebarItem) => {
return group.items!.map((items: DefaultTheme.SidebarItem) => ({
path: items.link!.replace(/^\/+/, '') ?? '',
name: items.text ?? ''
siteMapUrls = VitePressConfig.themeConfig?.sidebar?.map((group: DefaultTheme.SidebarItem) => {
return group.items!.map((items: DefaultTheme.SidebarItem) => (<SitemapUrl>{
location: items.link!.replace(/^\/+/, '') ?? '',
lastModified: new Date(),
}));
}).reduce((prev: SiteMapPluginUrls, curr: SiteMapPluginUrls) => {
}).reduce((prev: SitemapUrl[], curr: SitemapUrl[]) => {
return prev!.concat(curr!);
});
}

// https://vitejs.dev/config/
export default defineConfig({
plugins: [
SitemapPlugin({
sitemap({
baseUrl: docsBaseUrl,
contentBase: './docs/.vitepress/dist',
routes: siteMapRoutes,
urls: siteMapUrls,
})
],
server: {
Expand Down
Loading

0 comments on commit ebf2ab1

Please sign in to comment.