e4035b2509
These are some changes in the way the monorepo is structured, that are aimed at making it easier to get started. There are two important changes: **Multiple workspaces** We had a yarn workspaces setup at `packages/*`. But our monorepo has grown to 92 packages which can be overwhelming for people not familiar with the package names. To remedy this, I've split it into 4 different workspaces: - `designs/*`: Holds FreeSewing designs (think patterns) - `plugins/*`: Holds FreeSewing plugins - `packages/*`: Holds other packages published on NPM - `sites/*`: Holds software that is not published as an NPM package, such as our various websites and backend API This should make it easier to find things, and to answer questions like *where do I find the code for the plugins*. **Updated reconfigure script to handle build order** One problem when bootstrapping the repo is inter-dependencies between packages. For example, building a pattern will only work once `plugin-bundle` is built. Which will only work once all plugins in the bundle or built. And that will only work when `core` is built, and so on. This can be frustrating for new users as `yarn buildall` will fail. And it gets overlooked by seasoned devs because they're likely to have every package built in their repo so this issue doesn't concern them. To remedy this, we now have a `config/build-order.mjs` file and the updated `/scripts/reconfigure.mjs` script will enforce the build order so that things *just work*.
69 lines
1.8 KiB
JavaScript
69 lines
1.8 KiB
JavaScript
// MDX compiler
|
|
import { compile } from '@mdx-js/mdx'
|
|
|
|
// Remark plugins we want to use
|
|
import remarkFrontmatter from 'remark-frontmatter'
|
|
import remarkGfm from 'remark-gfm'
|
|
import { remarkIntroPlugin } from './remark-intro-plugin.mjs'
|
|
import smartypants from 'remark-smartypants'
|
|
import mdxPluginToc from './mdx-plugin-toc.mjs'
|
|
// Rehype plugins we want to use
|
|
import rehypeHighlight from 'rehype-highlight'
|
|
import rehypeAutolinkHeadings from 'rehype-autolink-headings'
|
|
import rehypeSlug from 'rehype-slug'
|
|
// Simple frontmatter extractor
|
|
import frontmatter from 'front-matter'
|
|
/*
|
|
* Summary: Compiles the markdown it receives to MDX.
|
|
*
|
|
* @param (string) language - language to load (eg: 'en')
|
|
* @param (string) site - site to load (either 'dev' or 'org')
|
|
* @param (string) slug - slug of the page (eg: 'guides/patterns')
|
|
*
|
|
* @link https://mdxjs.com/guides/mdx-on-demand/
|
|
*
|
|
*/
|
|
const mdxCompiler = async (md) => {
|
|
|
|
const intro = []
|
|
const mdx = String(
|
|
await compile(md, {
|
|
outputFormat: 'function-body',
|
|
remarkPlugins: [
|
|
remarkFrontmatter,
|
|
remarkGfm,
|
|
smartypants,
|
|
[
|
|
remarkIntroPlugin,
|
|
{ intro }
|
|
]
|
|
],
|
|
rehypePlugins: [
|
|
[rehypeHighlight, { plainText: ['dot', 'http'] }],
|
|
rehypeSlug,
|
|
rehypeAutolinkHeadings,
|
|
],
|
|
})
|
|
)
|
|
|
|
// This is not ideal as we're adding a second pass but for now it will do
|
|
// See: https://github.com/remarkjs/remark-toc/issues/37
|
|
const toc = String(
|
|
await compile(md, {
|
|
outputFormat: 'function-body',
|
|
remarkPlugins: [
|
|
remarkFrontmatter,
|
|
remarkGfm,
|
|
smartypants,
|
|
mdxPluginToc,
|
|
],
|
|
rehypePlugins: [
|
|
rehypeSlug,
|
|
],
|
|
})
|
|
)
|
|
|
|
return { mdx, intro, toc, frontmatter: frontmatter(md)?.attributes }
|
|
}
|
|
|
|
export default mdxCompiler
|