remark plugin - ability to pull in entire files outside of code blocks about dnp3 HOT 5 CLOSED

I think you can do it with this: https://mdxjs.com/getting-started#documents

So something like this:

import Changelog from '../CHANGELOG.md`
<Changelog /> 

from dnp3.

It didn't like the following raw markdown:

### 0.9.0 ###
* :tada: first official release

result:

from dnp3.

This is caused because the CHANGELOG.md file is not inside the /guide directory, so outside the docusaurus project. I tried writing a plugin for docusaurus with the following content, but it doesn't work (it tries to resolve configuration files that do not exist) and I gave up on it.

module.exports = function(ctx, options) {
    return {
        name: 'webpack-config',
        configureWebpack(config, isServer, utils) {
            var mdxConfig = config.module.rules[config.module.rules.length - 1];
            console.log(mdxConfig);
            return {
                module: {
                    rules: [
                        {
                            test: /(CHANGELOG.md)$/,
                            include: ['D:\\Desktop\\stepfunc\\dnp3'],
                            use: ['babel-loader', '@docusaurus/mdx-loader', '@docusaurus/plugin-content-pages/lib/markdownLoader'],
                        }
                    ]
                }
            }
        }
      };
}

The remaining solutions would be to create a symlink inside the /guide directory, but I'm not sure how git is going to handle it. Or, we could just link to the changelog on GitHub.

from dnp3.

I think linking to the changelog will be fine, so long as we can use a global version constant from the configuration to generate the link.

from dnp3.

I got it working in 1dec86b It copies the CHANGELOG.md to the appropriate directory so we can import it inline. Also, I added in 7aa3508 a JSON to contain the current version number (and other global information in the future) that we can reference from the docs. See https://github.com/stepfunc/dnp3/blob/1dec86b18a8ed2372b4e49f30f0d6ae8e5cacc0e/guide/docs/about/versioning.mdx for an example.

from dnp3.