github-cms

WIP 🚧

Dieses Feature ist ein Work in Progress. Es funktioniert weitgehend, kann aber noch (einige) Fehler enthalten. Es wird von 👉 hfr entwickelt und ist noch nicht offiziell von Teaching Dev unterstützt.

Installation

siteConfig.ts

import githubCmsPlugin from '../packages/hfr/github-cms/plugin';

export default {
    // ...
    showEditThisPageOptions: [/*...*/, 'cms'],
    plugins: [
        // ...
        githubCmsPlugin({
            /**
             * use the same configs as specified in your SiteConfig,
             * except for `SiteConfig.pages.path`
            */
            pages: {},
            remarkPlugins: recommendedRemarkPlugins,
            rehypePlugins: recommendedRehypePlugins,
            beforeDefaultRemarkPlugins: recommendedBeforeDefaultRemarkPlugins
        })
    ],
    dynamicRoutes: [
        // ...
        {
            path: '/cms/',
            component: '@hfr/github-cms/components'
        }
    ],
    apiDocumentProviders: [
        // ...
        require.resolve('@hfr/github-cms/register')
    ]
};