https://github.com/pichfl/ia-writer-templates-dev

Preview and create your own templates for iA Writer with ease.
https://github.com/pichfl/ia-writer-templates-dev

Last synced: about 2 months ago
JSON representation

Preview and create your own templates for iA Writer with ease.

• Host: GitHub
• URL: https://github.com/pichfl/ia-writer-templates-dev
• Owner: pichfl
• License: mit
• Created: 2018-02-09T16:07:34.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T08:33:19.000Z (about 2 years ago)
• Last Synced: 2024-10-04T13:19:39.571Z (3 months ago)
• Language: JavaScript
• Size: 2.35 MB
• Stars: 31
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred-test - pichfl/ia-writer-templates-dev - Preview and create your own templates for iA Writer with ease. (JavaScript)

README

        
# iA-Writer-Templates-Dev

Preview and create your own templates for iA Writer with ease.

## Requirements

-   [Node.js][node]

-   [Yarn][yarn]

-   [Gulp][gulp] - `yarn --global gulp-cli`

## Setup

1. Clone or download this repository.

2. Navigate to the repository in your Terminal.

3. Run `yarn` to install dependencies.

4. Run `gulp` to start the development server

## Development

Put your template bundles in `src/templates` and rename `style.css` to `style.scss`.

The styles are parsed by [SASS][sass] and [PostCSS Autoprefixer][autoprefixer]. This allows to write CSS without relying on vendor prefixes.

SCSS allows importing additional and shared files. For example a `_typography.scss` placed in `src/styles` could be imported by writing `@import '../../../../styles/typography';` inside the `style.scss` in a template bundle, which is useful if you plan to create multiple bundles sharing some code.

Sample content can be put into `src/content`, one Markdown file per template bundle. Make sure the names match. Since this project can't use the same Markdown engine that iA Writer uses, the rendered Markdown is only an estimate. If something looks off or is not supported check your bundle in iA Writer. It is not planned to reimplement the exact rendering.

## Output

Output is stored in the `dist` folder.

## Notes

Since CSS is not quite made for print, please keep in mind that A4 (210mm by 297mm) roughly translates to 596 by 842 px. The demo pages contain CSS which adds this height as a min-height to the body.

## Credits

-   Kristina for the idea

## Author

-   [Florian Pichler][pichfl]

[node]: https://nodejs.org

[yarn]: https://yarnpkg.comc

[gulp]: https://gulpjs.com

[sass]: http://sass-lang.com

[autoprefixer]: https://github.com/postcss/autoprefixer

[pichfl]: https://florianpichler.de