Giter Club home page Giter Club logo

homebrewery-vscode's Introduction

Styles the markdown preview pane like the Homebrewery, so that you can create 5th Edition D&D homebrew in a more powerful application.

preview-image

Features

  • Most markdown and formatting from the Homebrewery is supported.
  • Use \page to create new pages.
  • Most of the same snippets The Homebrewery provides are available with the 'brew' prefix. Ex: brewStatBlock

Commands

homebrewery.toggle

toggles the homebrewery.enabled setting

homebrewery.brew

print to HTML

Settings

homebrewery.enabled

use homebrewery formatting in the markdown preview pane. true by default.

Usage

For best results, set the following options:

  • "markdown.preview.scrollEditorWithPreview": false
  • "markdown.preview.scrollPreviewWithEditor": false
  • "markdown.preview.markEditorSelection": false

This prevents the preview jumping around and stops the formatting breaking when mousing over selections in the preview window.

Known Issues

  • Any div element used requires a new line between the div and its content
  • The HTML rendered by the homebrewery.brew command is sometimes slightly different than the preview.
  • Images from external URLs may not be shown. This is due to security restrictions on Code's markdown preview. For best results, ensure that all image urls use https://. Though it is not recommended, you can also disable security.
  • The preview will sometimes scroll to the wrong place. See Usage above.

To-Do List

  • Allow for alternate styles and color palettes

Release Notes

0.1.0

  • Added brew command to print to HTML

0.0.4

  • Added remaining snippets
  • Both manual and auto page numbering work.

0.0.3

  • Added toggle command to enable/disable homebrewery formatting

See Changelog for more.

homebrewery-vscode's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.