-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
β add @microsoft/api-extractor, @microsoft/api-documenter, npm-run-all π§ setup api extractor π§ update turborepo config π¨ update scripts π· update actions
Showing
17 changed files
with
517 additions
and
171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,3 +13,4 @@ jobs: | |
with: | ||
publish_dir: docs/.vitepress/dist | ||
cname: fff.js.org | ||
build_command: pnpm docs:build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"apiReport": { | ||
"enabled": false | ||
}, | ||
"bundledPackages": [ | ||
"fff-flavored-frontmatter", | ||
"indiekit-preset-fff", | ||
"markdown-it-fff", | ||
"remark-fff" | ||
], | ||
"compiler": {}, | ||
"docModel": { | ||
"apiJsonFilePath": "<projectFolder>/dist/api-extractor/<unscopedPackageName>.api.json", | ||
"enabled": true | ||
}, | ||
"dtsRollup": { | ||
"enabled": false | ||
}, | ||
"mainEntryPointFilePath": "<projectFolder>/packages/<unscopedPackageName>/dist/index.d.ts", | ||
"messages": { | ||
"compilerMessageReporting": { | ||
"default": { | ||
"logLevel": "warning" | ||
} | ||
}, | ||
"extractorMessageReporting": { | ||
"ae-wrong-input-file-type": { | ||
"logLevel": "warning" | ||
}, | ||
"default": { | ||
"logLevel": "warning" | ||
} | ||
}, | ||
"tsdocMessageReporting": { | ||
"default": { | ||
"logLevel": "warning" | ||
} | ||
} | ||
}, | ||
"tsdocMetadata": { | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,202 +1,218 @@ | ||
import { version } from '../package.json' | ||
import { defineConfig } from 'vitepress' | ||
import { withPwa } from '@vite-pwa/vitepress' | ||
import footnote from 'markdown-it-footnote' | ||
import { defineConfig } from 'vitepress' | ||
|
||
import { version } from '../package.json' | ||
|
||
const nav = () => [ | ||
{ | ||
text: version, | ||
items: [ | ||
{ | ||
text: 'Changelog', | ||
link: '/version/changelog', | ||
text: 'Changelog', | ||
}, | ||
{ | ||
text: 'Contributing', | ||
link: '/intro/contributing', | ||
text: 'Contributing', | ||
}, | ||
], | ||
text: version, | ||
}, | ||
] | ||
|
||
const sidebar = () => [ | ||
{ | ||
text: 'Introduction', | ||
collapsible: true, | ||
items: [ | ||
{ text: 'What is FFF?', link: '/intro/what-is-fff' }, | ||
{ text: 'Implementing', link: '/intro/implementing' }, | ||
{ link: '/intro/what-is-fff', text: 'What is FFF?' }, | ||
{ link: '/intro/implementing', text: 'Implementing' }, | ||
{ | ||
text: 'Contributing', | ||
link: '/intro/contributing', | ||
text: 'Contributing', | ||
}, | ||
{ text: 'Showcase', link: '/intro/showcase' }, | ||
{ link: '/intro/showcase', text: 'Showcase' }, | ||
], | ||
text: 'Introduction', | ||
}, | ||
{ | ||
text: 'Concepts', | ||
collapsible: true, | ||
items: [ | ||
{ | ||
text: 'Object Media', | ||
link: '/concepts/object-media', | ||
text: 'Object Media', | ||
}, | ||
{ | ||
text: 'Flags', | ||
link: '/concepts/flags', | ||
text: 'Flags', | ||
}, | ||
{ | ||
link: '/concepts/flavor-transform', | ||
text: 'Flavor Transform', | ||
link: '/concepts/flavor-transform' | ||
} | ||
}, | ||
], | ||
text: 'Concepts', | ||
}, | ||
{ | ||
collapsible: true, | ||
items: [ | ||
{ | ||
link: '/packages/fff-flavored-frontmatter', | ||
text: 'fff-flavored-frontmatter', | ||
}, | ||
{ link: '/packages/remark-fff', text: 'remark-fff' }, | ||
{ link: '/packages/markdown-it-fff', text: 'markdown-it-fff' }, | ||
{ link: '/packages/indiekit-preset-fff', text: 'indiekit-preset-fff' }, | ||
{ link: '/packages/create-fff', text: 'create-fff' }, | ||
], | ||
text: 'Packages', | ||
}, | ||
{ | ||
collapsible: true, | ||
items: [ | ||
{ | ||
link: '/references/fff-flavored-frontmatter', | ||
text: 'fff-flavored-frontmatter', | ||
link: '/packages/fff-flavored-frontmatter', | ||
}, | ||
{ text: 'remark-fff', link: '/packages/remark-fff' }, | ||
{ text: 'markdown-it-fff', link: '/packages/markdown-it-fff' }, | ||
{ text: 'indiekit-preset-fff', link: '/packages/indiekit-preset-fff' }, | ||
{ text: 'create-fff', link: '/packages/create-fff'} | ||
{ link: '/references/remark-fff', text: 'remark-fff' }, | ||
{ link: '/references/markdown-it-fff', text: 'markdown-it-fff' }, | ||
{ link: '/references/indiekit-preset-fff', text: 'indiekit-preset-fff' }, | ||
// { link: '/references/create-fff', text: 'create-fff' }, | ||
], | ||
link: '/references/index', | ||
text: 'References', | ||
}, | ||
{ | ||
text: 'Version', | ||
collapsible: true, | ||
items: [ | ||
{ text: 'Changelog', link: '/version/changelog' }, | ||
{ text: '0.6 (draft)', link: '/version/0.6'}, | ||
{ text: '0.5', link: '/version/0.5' }, | ||
{ text: '0.4', link: '/version/0.4' }, | ||
{ text: '0.3', link: '/version/0.3' }, | ||
{ text: '0.2', link: '/version/0.2' }, | ||
{ text: '0.1', link: '/version/0.1' }, | ||
{ link: '/version/changelog', text: 'Changelog' }, | ||
{ link: '/version/0.6', text: '0.6 (draft)' }, | ||
{ link: '/version/0.5', text: '0.5' }, | ||
{ link: '/version/0.4', text: '0.4' }, | ||
{ link: '/version/0.3', text: '0.3' }, | ||
{ link: '/version/0.2', text: '0.2' }, | ||
{ link: '/version/0.1', text: '0.1' }, | ||
], | ||
text: 'Version', | ||
}, | ||
] | ||
|
||
export default withPwa( | ||
defineConfig({ | ||
lang: 'en-US', | ||
title: 'FFF Flavored Frontmatter', | ||
titleTemplate: 'FFF', | ||
description: 'The Flexible & Functional Frontmatter Solution.', | ||
appearance: 'dark', | ||
lastUpdated: true, | ||
markdown: { | ||
theme: { | ||
light: 'material-theme-lighter', | ||
dark: 'material-theme-darker', | ||
}, | ||
config: (md) => md.use(footnote), | ||
}, | ||
description: 'The Flexible & Functional Frontmatter Solution.', | ||
head: [ | ||
[ | ||
'link', | ||
{ rel: 'icon', href: '/glowing_star.svg', type: 'image/svg+xml' }, | ||
{ href: '/glowing_star.svg', rel: 'icon', type: 'image/svg+xml' }, | ||
], | ||
[ | ||
'link', | ||
{ | ||
rel: 'manifest', | ||
href: '/manifest.webmanifest', | ||
rel: 'manifest', | ||
type: 'application/manifest+json', | ||
}, | ||
], | ||
[ | ||
'meta', | ||
{ | ||
property: 'og:image', | ||
content: | ||
'https://og-image.vercel.app/**FFF**%20Flavored%20Frontmatter.png?theme=dark&md=1&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fvercel-triangle-white.svg&images=https%3A%2F%2Ffff.js.org%2Fglowing_star.svg&widths=256&widths=384&heights=256&heights=384', | ||
property: 'og:image', | ||
}, | ||
], | ||
[ | ||
'meta', | ||
{ | ||
property: 'twitter:image', | ||
content: | ||
'https://og-image.vercel.app/**FFF**%20Flavored%20Frontmatter.png?theme=dark&md=1&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fvercel-triangle-white.svg&images=https%3A%2F%2Ffff.js.org%2Fglowing_star.svg&widths=256&widths=384&heights=256&heights=384', | ||
property: 'twitter:image', | ||
}, | ||
], | ||
['meta', { property: 'twitter:card', content: 'summary' }], | ||
['meta', { content: 'summary', property: 'twitter:card' }], | ||
[ | ||
'script', | ||
{ | ||
src: 'https://plausible.kwaa.dev/js/plausible.js', | ||
defer: '', | ||
'data-domain': 'fff.js.org', | ||
'defer': '', | ||
'src': 'https://plausible.kwaa.dev/js/plausible.js', | ||
}, | ||
], | ||
], | ||
themeConfig: { | ||
nav: nav(), | ||
sidebar: sidebar(), | ||
siteTitle: 'FFF', | ||
logo: '/glowing_star.svg', | ||
socialLinks: [ | ||
{ icon: 'github', link: 'https://github.com/importantimport/fff' }, | ||
], | ||
editLink: { | ||
pattern: 'https://github.com/importantimport/fff/edit/main/:path', | ||
text: 'Suggest changes to this page', | ||
lang: 'en-US', | ||
lastUpdated: true, | ||
markdown: { | ||
config: md => md.use(footnote), | ||
theme: { | ||
dark: 'material-theme-darker', | ||
light: 'material-theme-lighter', | ||
}, | ||
}, | ||
pwa: { | ||
registerType: 'autoUpdate', | ||
includeManifestIcons: false, | ||
manifest: { | ||
id: '/', | ||
name: 'FFF Flavored Frontmatter', | ||
short_name: 'FFF', | ||
description: 'The Flexible & Functional Frontmatter Solution.', | ||
theme_color: '#fdd835', | ||
icons: [ | ||
{ | ||
src: 'glowing_star.svg', | ||
purpose: 'any', | ||
sizes: 'any', | ||
src: 'glowing_star.svg', | ||
type: 'image/svg+xml', | ||
purpose: 'any', | ||
}, | ||
], | ||
id: '/', | ||
name: 'FFF Flavored Frontmatter', | ||
short_name: 'FFF', | ||
theme_color: '#fdd835', | ||
}, | ||
registerType: 'autoUpdate', | ||
workbox: { | ||
runtimeCaching: [ | ||
{ | ||
urlPattern: /^https:\/\/fonts\.googleapis\.com\/.*/i, | ||
handler: 'CacheFirst', | ||
options: { | ||
cacheName: 'google-fonts-cache', | ||
expiration: { | ||
maxEntries: 10, | ||
maxAgeSeconds: 60 * 60 * 24 * 365, | ||
}, | ||
cacheableResponse: { | ||
statuses: [0, 200], | ||
}, | ||
expiration: { | ||
maxAgeSeconds: 60 * 60 * 24 * 365, | ||
maxEntries: 10, | ||
}, | ||
}, | ||
urlPattern: /^https:\/\/fonts\.googleapis\.com\/.*/i, | ||
}, | ||
{ | ||
urlPattern: /^https:\/\/fonts\.gstatic\.com\/.*/i, | ||
handler: 'CacheFirst', | ||
options: { | ||
cacheName: 'gstatic-fonts-cache', | ||
expiration: { | ||
maxEntries: 10, | ||
maxAgeSeconds: 60 * 60 * 24 * 365, | ||
}, | ||
cacheableResponse: { | ||
statuses: [0, 200], | ||
}, | ||
expiration: { | ||
maxAgeSeconds: 60 * 60 * 24 * 365, | ||
maxEntries: 10, | ||
}, | ||
}, | ||
urlPattern: /^https:\/\/fonts\.gstatic\.com\/.*/i, | ||
}, | ||
], | ||
}, | ||
}, | ||
}) | ||
themeConfig: { | ||
editLink: { | ||
pattern: 'https://github.com/importantimport/fff/edit/main/:path', | ||
text: 'Suggest changes to this page', | ||
}, | ||
logo: '/glowing_star.svg', | ||
nav: nav(), | ||
sidebar: sidebar(), | ||
siteTitle: 'FFF', | ||
socialLinks: [ | ||
{ icon: 'github', link: 'https://github.com/importantimport/fff' }, | ||
], | ||
}, | ||
title: 'FFF Flavored Frontmatter', | ||
titleTemplate: 'FFF', | ||
}), | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"extends": "../../api-extractor.json", | ||
"mainEntryPointFilePath": "<projectFolder>/packages/<unscopedPackageName>/dist/fff.d.ts" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"extends": "../../api-extractor.json", | ||
"mainEntryPointFilePath": "<projectFolder>/packages/<unscopedPackageName>/dist/index.d.ts" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"extends": "../../api-extractor.json", | ||
"mainEntryPointFilePath": "<projectFolder>/packages/<unscopedPackageName>/dist/index.d.ts" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"extends": "../../api-extractor.json", | ||
"mainEntryPointFilePath": "<projectFolder>/packages/<unscopedPackageName>/dist/index.d.ts" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,32 @@ | ||
{ | ||
"$schema": "https://turbo.build/schema.json", | ||
"globalDependencies": [ | ||
".env", | ||
"tsconfig.json", | ||
"tsup.config.ts" | ||
], | ||
"pipeline": { | ||
"api-extractor": { | ||
"cache": false, | ||
"dependsOn": ["^build"] | ||
}, | ||
"build": { | ||
"dependsOn": [ | ||
"^build" | ||
], | ||
"dependsOn": ["^build"], | ||
"outputs": [ | ||
".vitepress/dist/**", | ||
"dist/**" | ||
] | ||
}, | ||
"coverage": { | ||
"outputs": ["coverage/**"] | ||
}, | ||
"lint": {}, | ||
"lint:fix": {}, | ||
"test": { | ||
"outputs": [] | ||
}, | ||
"test:watch": { | ||
"cache": false | ||
}, | ||
"coverage": {}, | ||
"lint": {}, | ||
"lint:fix": {} | ||
}, | ||
"globalDependencies": [ | ||
".env", | ||
"tsconfig.json", | ||
"tsup.config.ts" | ||
] | ||
} | ||
} | ||
} |