2023-12-12 05:00:33 +08:00
|
|
|
import * as path from 'node:path';
|
|
|
|
|
import * as url from 'node:url';
|
2023-12-22 13:27:13 +08:00
|
|
|
import { rewriteRules } from './middleware.js';
|
2023-12-12 05:00:33 +08:00
|
|
|
|
|
|
|
|
const __filename = url.fileURLToPath(import.meta.url);
|
|
|
|
|
const __dirname = path.dirname(__filename);
|
2023-12-22 13:27:13 +08:00
|
|
|
|
|
|
|
|
// Production (CDN URLs, watch disabled)
|
|
|
|
|
export const prodConfig = {
|
feat: v5 style overhaul (#2469)
Style updates:
- New "core" theme serves as base for all other themes (official and third-party)
- New CSS custom properties for simplified customization of "core" theme
**Note:** List of available properties will be made available in documentation by embedding soruce CSS in docs after merge. Merge is required because embedded CSS needs to be in `main` branch. For now, see `_vars.css` and `_vars-advanced.css` for details.
- New theme "add-ons" modify core theme properties and/or add custom declarations as needed.
- New Prism.js theme support
- New configurable sidebar toggle design
- New typography defaults to system sans-serif and monospace fonts instead of relying on external web font.
- New "Core Dark" theme addon provide dark theme styles. Can optionally be applied based on operating system's light/dark setting using `@media` attribute on `<link>` element.
- New "Vue" theme addon. Closely replicated popular v4 theme while allowing for v5 enhancements.
- New CSS class names available for adding loading indicators, adding sidebar expand/collapse icons, adding sidebar group styles, clamping sidebar links to a single line with ellipses, and changing the sidebar toggle icon.
- New auto-generated gradient background for cover page (ensure gradient hue is > 50 degree apart, use OKLCH color if supported, randomize grandient angle, reduce brightness in dark mode)
- New button styles (basic, primary, secondary)
- New form element styles (text input, radio, checkbox, )
- New "callouts" (previously "important" and "tip" helpers)
- New default syntax highlighting theme (from [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/))
- New auto-generated theme color shade and tint colors
- New auto-generated monochromatic color palette
- New form element styles (fields, legend, text input, text area, checkbox, radio, toggles, and select)
- New "headerless" tables
- New `kbd` styles
- New task list style
- New merged navbar styles (consistent with sidebar nav styles)
- New search plugin styles and keyboard shortcut indicators
- Add ability restore previously focused content element after hiding sidebar
- Add "focus trap" when sidebar is visible on mobile (accessibility)
- Add ability for sidebar links to wrap by default (previous single-line w/ ellipsis display available as CSS class on `<body>` option)
- Add sidebar `page-link`, `group`, and `group-title` CSS classes to sidebar markup.
- Add reduced motion media query to set all animation/transition timings to zero
- Update Google Font imports (use new variable vs older fixed width fonts)
- Update primary/secondary button order on coverpage (primary should be first)
- Fix missing merged navbar when loading at desktop resolution then resizing to mobile
- Fix inverted open/close sidebar visibility state at desktop/mobile resolutions
- Fix overflow setting to prevent clipping of element focus ring
- Fix safe area inset margins on mobile in landscape orientation
- Fix inverted "tip" and "warn" class names
- Fix scroll padding to prevent headers from touching top edge of viewport when scrolled to
- Remove Stylus dependency (now using only PostCSS)
- Remove legacy themes "Buble", "Dark", "Dolphin", and "Pure".
Documentation updates:
- New "UI Kit" page showcasing all elements styled by Docsify
- Update "Quick Start" page template
- Update "Adding pages" page with information on how to properly create sidebar group titles and navbar drop-down menus
- Update "Themes" page with theme and class toggles
- Update "Configuration" page with deprecation warnings for `themeColor` and `topMargin`
- Move "Edit Page" link to footer
- Remove [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/) endorsement (currently not compatible with v5 and future is unknown)
Miscellaneous updates:
- New search plugin options: `insertBefore` and `insertAfter`
- Add PostCSS config file
- Update BrowserSync config (disable "ghost" mode)
- Update tests
- Fix Jest + Prettier 3 conflict
- Fix `getAndRemoveDocisfyIgnoreConfig` name type (now `Docisfy` => `Docsify`)
- Fix execution of sidebar-generating code when `hiddenSidebar` is `true`
- Remove `inBrowser` constant (SSR deprecated, so no longer needed)
2024-07-19 23:34:51 +08:00
|
|
|
ghostMode: false,
|
2023-12-12 05:00:33 +08:00
|
|
|
hostname: '127.0.0.1',
|
|
|
|
|
notify: false,
|
|
|
|
|
open: false,
|
2023-12-22 13:27:13 +08:00
|
|
|
port: 8080,
|
|
|
|
|
server: {
|
|
|
|
|
baseDir: './docs',
|
|
|
|
|
},
|
|
|
|
|
snippet: false,
|
|
|
|
|
ui: false,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// Development (local URLs, watch enabled)
|
|
|
|
|
export const devConfig = {
|
|
|
|
|
...prodConfig,
|
2024-05-22 04:19:21 +08:00
|
|
|
files: ['CHANGELOG.md', 'docs/**/*', 'dist/**/*'],
|
2023-12-22 13:27:13 +08:00
|
|
|
port: 3000,
|
|
|
|
|
rewriteRules,
|
2024-04-17 11:52:48 +08:00
|
|
|
reloadDebounce: 1000,
|
|
|
|
|
reloadOnRestart: true,
|
2023-12-12 05:00:33 +08:00
|
|
|
server: {
|
2023-12-22 13:27:13 +08:00
|
|
|
...prodConfig.server,
|
2023-12-12 05:00:33 +08:00
|
|
|
routes: {
|
|
|
|
|
'/changelog.md': path.resolve(__dirname, 'CHANGELOG.md'),
|
2024-05-22 04:19:21 +08:00
|
|
|
'/dist': path.resolve(__dirname, 'dist'),
|
2023-12-12 05:00:33 +08:00
|
|
|
'/node_modules': path.resolve(__dirname, 'node_modules'), // Required for automated Vue tests
|
|
|
|
|
},
|
|
|
|
|
},
|
2023-12-22 13:27:13 +08:00
|
|
|
snippet: true,
|
2023-12-12 05:00:33 +08:00
|
|
|
};
|
|
|
|
|
|
2023-12-22 13:27:13 +08:00
|
|
|
// Test (local URLs, watch disabled)
|
|
|
|
|
export const testConfig = {
|
|
|
|
|
...devConfig,
|
|
|
|
|
port: 4000,
|
|
|
|
|
server: {
|
|
|
|
|
...devConfig.server,
|
2023-12-12 05:00:33 +08:00
|
|
|
middleware: [
|
|
|
|
|
// Blank page required for test environment
|
|
|
|
|
{
|
|
|
|
|
route: '/_blank.html',
|
|
|
|
|
handle(req, res, next) {
|
|
|
|
|
res.setHeader('Content-Type', 'text/html');
|
2024-05-20 00:49:33 +08:00
|
|
|
res.end('<!DOCTYPE html><html><body></body></html>');
|
2023-12-12 05:00:33 +08:00
|
|
|
next();
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2023-12-22 13:27:13 +08:00
|
|
|
snippet: false,
|
|
|
|
|
watch: false,
|
2023-12-12 05:00:33 +08:00
|
|
|
};
|