# @razroo/razroo-markdown-engine

Latest version **1.4.7** (published 2024-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @razroo/razroo-markdown-engine
pnpm add @razroo/razroo-markdown-engine
yarn add @razroo/razroo-markdown-engine
bun add @razroo/razroo-markdown-engine
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.7 |
| Published | 2024-04-22 |
| First published | 2024-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 16 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Charlie Greenman |
| Maintainers | razroo |

## Links

- npm: https://www.npmjs.com/package/@razroo/razroo-markdown-engine
- Repository: https://github.com/razroo/razroo-markdown-engine
- Homepage: https://github.com/razroo/razroo-markdown-engine#readme
- Issues: https://github.com/razroo/razroo-markdown-engine/issues
- npm.io page: https://npm.io/package/@razroo/razroo-markdown-engine

## Dependencies (16)

- [url](https://npm.io/package/url.md) 0.11.0
- [yargs](https://npm.io/package/yargs.md) 16.1.1
- [dotenv](https://npm.io/package/dotenv.md) 8.2.0
- [remark](https://npm.io/package/remark.md) 11.0.0
- [to-vfile](https://npm.io/package/to-vfile.md) 6.1.0
- [micromatch](https://npm.io/package/micromatch.md) 4.0.2
- [remark-html](https://npm.io/package/remark-html.md) 13.0.1
- [remark-slug](https://npm.io/package/remark-slug.md) 6.0.0
- [remark-parse](https://npm.io/package/remark-parse.md) 9.0.0
- [remark-prism](https://npm.io/package/remark-prism.md) 1.3.6
- [vfile-reporter](https://npm.io/package/vfile-reporter.md) 6.0.2
- [remark-stringify](https://npm.io/package/remark-stringify.md) 9.0.1
- [remark-variables](https://npm.io/package/remark-variables.md) 1.4.9
- [remark-autolink-headings](https://npm.io/package/remark-autolink-headings.md) 6.0.1
- [@razroo/razroo-remark-netlify](https://npm.io/package/@razroo/razroo-remark-netlify.md) 1.2.3
- [@razroo/razroo-remark-embed-code](https://npm.io/package/@razroo/razroo-remark-embed-code.md) ^2.0.1

## Recent versions

- 1.4.7 (latest) — 2024-04-22

## README

<p align="center">
  <a href="https://www.razroo.com">
    <img alt="Razroo Logo" src="https://assets.razroo.com/razroo_logo_8f8785be23.svg" width="200" />
  </a>
</p>

# Razroo Markdown Engine #
The Razroo Markdown Engine is Razroo's attempt towards making markdown something that is more automated 
and has more sophisticated features available by type setting languages such as LaTeX. We wanted it to be written in 
Markdown, and-also compile to Markdown. This makes it, so it can be used on multiple platforms. In addition, the 
Markdown Engine is sophisticated enough to where we can pull in data, similar to how data is pulled in using an API. 
This allows us to have a very sophisticated, pseudo-autonomous content engine.

## How It Came To Be ##
First and foremost, we worked with LaTeX for the, at the time, standalone Angular: The Full Gamut book. 

1. What we found is that LaTeX had an issue compiling at times. 
2. For certain technical folk who never used LaTeX before, we found that there was a tremendous learning curve. 
3. Adding LaTeX didn't allow us to modify anything. For Razroo which as an organization is very content heavy, 
it is important that we can modify the content ourselves. LaTeX uses C++, and we wanted to be able to use 
Typescript/Node.
4. LaTeX to web formats seemed like a real challenge, there had to be an easier way to do this. 

## Features of the Razroo Markdown Engine ##

### Inject Github Links ###
Allows Markdown to pull in github links from both internal and external repos. The Github links are then built into the 
`build` folder. 

For instance:
```
Sample content before. 

!()[https://github.com/facebook/react/blob/ad6f3d5c55a79e8a44798aad36118e73de3a64f8/packages/create-subscription/index.ts#L10-L12]

Sample content after.
```
turns into:

```
Sample content before. 

'use strict';

export * from './src/createSubscription';

Sample content after.
``` 

### Variables ###
```
In this {{format}}
```

will be 
```
In this chapter
```
For book builds, and
```
In this article
```
for article builds.

## Razroo Markdown Engine is an internal NPM repo 

Razroo uses Github Packages for internal NPM packages. In order to use Razroo's Github Packages/internal NPm repos you will have to run `npm login` and generate a personal access token. This will hook up your github username to the Razroo npm repo. If you have access to the respective npm repo, you 

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token

---
_Source: https://npm.io/package/@razroo/razroo-markdown-engine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._