@k2052/example-article NPM

This is an article

Just an example article used in other articles. It is published to npm as =@k2052-words/example-article. See the article-with-next for a usage example

This is the README for using the article, if you want to actually read this article you can click over to src/README.org

Usage

An article is a npm package so all the typical npm stuff applies, npm publish, npm run build to build etc.

Including in a Project

Articles are npm packages so they can be easily included in a project. Install a markdown loader (such as mdx) into your favorite bundler and then just import like this:

import Article from "article-name/index.mdx"

const App = () => {
  return (
    <Article />
  )
}

TODO: Add js compilation

You can also import the javascript version by doing:

import Article from "article-name/index.js"

const App = () => {
  return (
    <Article />
  )
}

Assets

Articles are flat npm packages and using any assets is as simple as importing them:

import CoverImage from "article-name/assets/cover.png"

Components

Some articles use mdx and export components. You can import and use these like any JS module, you will need to make sure to run them through babel as the raw ES6 code is published and no commonjs modules are provided.

Building

You can build markdown, org, and mdx versions by running the build task e.g:

$ npm run build

Building Markdown

You can build a markdown version using the build:markdown task

$ npm run build:markdown

Publishing to NPM

Run the following:

$ npm run build && cd dist/ && npm publish --access public

Or:

$ npm run release

Publishing to Medium

Unfortunately medium has removed integration tokens and it is no longer possible to publish via cli. The quickest workflow is the following:

Generate markdown with npm run build:markdown
Use https://markdowntomedium.com/create

Publishing to Dev.to

Dev.to currently lacks an API so posting must be done manually. There is work being done on an API https://github.com/thepracticaldev/dev.to/issues/911