https://github.com/about7sharks/getarticles
A typescript library made with deno for getting markdown articles from a github repo.
https://github.com/about7sharks/getarticles
deno javascript library markdown typescript
Last synced: about 2 months ago
JSON representation
A typescript library made with deno for getting markdown articles from a github repo.
- Host: GitHub
- URL: https://github.com/about7sharks/getarticles
- Owner: About7Sharks
- Created: 2022-06-08T00:38:06.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-15T21:56:16.000Z (about 4 years ago)
- Last Synced: 2025-03-17T21:44:08.369Z (over 1 year ago)
- Topics: deno, javascript, library, markdown, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@about7sharks/get-articles
- Size: 1.23 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Blog API
[API DOCS](https://deno.land/x/getarticles@deno.land)
I highly recommend using deno to write libraries that can be used in the overall javascript ecosystem. By utilizing deno's built in tools and TypeScript, you can
easily write libraries that can be used in the browser, node, and Deno.
> ⚠️ This package is written in Deno and transpiled with
> [dnt (Deno to Node Transform)](https://github.com/denoland/dnt). Highly
> unstable and subject to changes.
This Library fetches markdown articles by specifying a repo and a user to fetch
it from.
## Usage
```js
const info = await getArticles({ user: "about7sharks", repo: "Markdown" });
```
## Installation
### Deno
If using in deno you can use a url import directly.
```js
import { getArticles } from "https://esm.sh/@about7sharks/get-articles";
```
### Node
If using in node you first need to install the package.
```bash
npm i @about7sharks/get-articles
```
```js
import { getArticles } from "@about7sharks/get-articles";
```
## Build
Builds out for node/browser and publish to npm
```bash
deno run -A _build.ts
cd npm
npm publish --access public
```