An open API service indexing awesome lists of open source software.

https://github.com/danmindru/pretext-changed-the-internet


https://github.com/danmindru/pretext-changed-the-internet

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

Pretext
==================

#### Pretext — Pure JS Multiline Text Measurement for Web UI
Unblock layout innovation with Pretext, a blazingly fast, zero-DOM JS library for robust, universal text measurement. OSS, MIT. Check benchmarks, try the demo, and power your next production UI.

> This website was generated with [pageai.pro](https://pageai.pro).

- [Installation](#installation)
- [Development](#development)
- [Build](#build)
- [Deploy](#deploy)
- [Extend / Customize](#extend--customize)
- [Post](#post)
- [Frequently Asked Questions](#frequently-asked-questions)
- [How can I add a custom MDX component?](#how-can-i-add-a-custom-mdx-component)
- [How can I add a blog layout?](#how-can-i-add-a-blog-layout)
- [How to add meta tags?](#how-to-add-meta-tags)

## Installation

```bash
npm i
```

## Development

First, run the development server:

```bash
npm run dev
```

## Build

To build the site for production, run the following command:

```bash
npm run build
```

## Deploy

**Vercel**

Codebase generated with Shipixen can be deployed to [Vercel](https://vercel.com) with 1 click. Read more [here](https://shipixen.com/boilerplate-documentation/vercel-deploy-integration).

**Netlify**

Codebase generated with Shipixen can be deployed to [Netlify](https://www.netlify.com/) with 1 click. Read more [here](https://shipixen.com/boilerplate-documentation/netlify-deploy-integration).

**Static hosting services / GitHub Pages / S3 / Firebase etc.**

See [documentation](https://shipixen.com/boilerplate-documentation/other-deployment-options#main) for more information on deploying to other services.

## Extend / Customize
See [configuration docs](https://shipixen.com/boilerplate-documentation/configuration#main).

Also check out:
- [Customizing the landing page](https://shipixen.com/boilerplate-documentation/customizing-landing-page#main) - how to customize the landing page
- [Landing page component examples](https://shipixen.com/demo/landing-page-component-examples)
- [Landing page templates](https://shipixen.com/demo/landing-page-templates)
- [Component explorer](https://shipixen.com/component-explorer-shadcn) - an overview of all UI components available in the template
- [Color theme explorer](https://shipixen.com/color-theme-explorer-shadcn)
- [Pricing page generator](https://shipixen.com/shadcn-pricing-page)

## Post

Posts on the Shipixen blog are written in Markdown and stored in the /data directory. To create a new post, make a new .mdx file in the /data directory.

Learn [how to write blog posts](https://shipixen.com/boilerplate-documentation/using-the-shipixen-blog#main) in mdx.

Content is modelled using [Contentlayer](https://www.contentlayer.dev/), which allows you to define your own content schema and use it to generate typed content objects. See [Contentlayer documentation](https://www.contentlayer.dev/docs/getting-started) for more information.

## Frequently Asked Questions

### How can I add a custom MDX component?
You need to include the component under `components/MDXComponents.tsx`.

See [a full example here](https://shipixen.com/boilerplate-documentation/creating-a-blog-mdx-component#main).

### How can I add a blog layout?
See [this tutorial on how to add a blog layout](https://shipixen.com/boilerplate-documentation/creating-a-layout#main).

### How to add meta tags?
There's a utility function, `getPageMetadata` that makes it easy to add meta tags to your pages. See [this tutorial](https://shipixen.com/boilerplate-documentation/adding-metas-to-a-page#main) for more information.