Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmscer/parshape
https://github.com/tmscer/parshape
nextjs tex vercel
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmscer/parshape
- Owner: tmscer
- Created: 2022-06-08T12:05:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-31T13:17:41.000Z (almost 2 years ago)
- Last Synced: 2023-03-11T10:23:11.119Z (over 1 year ago)
- Topics: nextjs, tex, vercel
- Language: JavaScript
- Homepage: https://parshape.com
- Size: 523 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Parshape
See [parshape.com](https://parshape.com) for a live version.
This project came to be as a semestral work in subject [Typography and TeX](https://petr.olsak.net/typotex.html).
Subject page on CTU's website can be found [here](https://bilakniha.cvut.cz/cs/predmet3407206.html).
## List of features
- draw a shape of your paragraph with
- lines
- lines that snap to a multiple of 15°
- half-circles
- n-point Bézier curve
- configure the app close to your TeX environment, this project can use
- `\baselineskip` and `\lineskip`
- `\hsize` and `\vsize`
- `\pagewidth` and `\page height`
- offset of text start: `\hoffset`, `\pdfhorigin`, `\voffset` and `\pdfvorigin`
## Static Build
[](https://github.com/tmscer/parshape/actions/workflows/static-build.yml)
To obtain a static build click the badge above and
go to the latest build. On successful static builds, there is a section called **Artifacts**
with a ZIP file.
To serve the contents of the ZIP file, unpack it and serve using any HTTP server.
My favourite way to do so is using
```console
$ npx http-server -p 9000 & # ensure you are in the correct directory
$ firefox localhost:9000
```
To create a build locally, run
```console
$ npm run build:static
```
after setting up your development environment using instructions below.
## Local development
Required programs:
- [Node.js](https://nodejs.org/en/download/) version >= 14 and compatible NPM
To get started, run the following commands:
```console
$ npm install # install dependencies
$ npm run dev # run local development server
```
A local build can be made with
```console
$ npm run build
```
and served with
```console
$ npm run start
```
## Documentation
This project is documented in two ways: code with its tests and a PDF file.
### Code and tests
Ideally all code should be tested -- don't understand what a line
of code does? Try to change it or remove it and see what functionality breaks
and which tests don't pass. Still have no clue? File an [issue](https://github.com/tmscer/parshape/issues/new).
React components should be understandable to a React developer. For everything
else there should be readable code (explanatory variables, short functions) and tests.
Jest is the chosen test runner. To run all tests, use:
```console
$ npm run test # or `npm run test:watch` when developing
```
### PDF
[](https://github.com/tmscer/parshape/actions/workflows/docs.yml)
To obtain the PDF doc file, click the badge above and select the latest successful run from branch `master`.
The PDF contains high-level introduction to the project and explanation of some used
algorithms and math formulas.
If you wish to compile the TeX source yourself, go to `./doc` and run
```console
$ lautex -fmt optex parshape.tex
```