Skip to content

KaivnD/presscraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Press Craft {.display-2 .text-center}


npm

You can create impress.js presentations simply with a MarkDown document Dynamicly.
Noitic:This very markdown file is also a impress.js presentation
Presscraft will handle sync your MarkDown File.
What is impress.js ? if you are wondering, you can check out this magic repository impress.js, which is why Presscraft can work.
Just simply press right arrow or space bar


See ! It's very easy

Just type - six times in your markdown file wherever you want, then you can create a presentation step, and put this step location at the beginning of the step like <!-- x=0 y=2000 -->, this comment, which will be removed in browser, descrip this step location. For Example: this markdow file you are reading.


Installation


  • I suggest add presscraft to development dependencies
npm install presscraft --save-dev
  • For global install
npm install -g presscraft
  • In case you're using yarn
yarn add presscraft -D

Useage

  • Install by --save-dev, you shoud add a script in your package.json, like example below:
{
  ...
  "scripts": {
    "psc": "presscraft -p 3000 -f /path/to/file" // -p means port, -f means file you want to view
  },
  "devDependencies": {
    "presscraft": "^0.0.5"
  }
  ...
}

Then you can start presscraft with npm run psc or yarn psc, then the browser should run automaticly.

  • For global installation, you can simply run presscraft -p 3000 -f /path/to/file

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published