added more content
This commit is contained in:
13
README.md
13
README.md
@@ -7,17 +7,22 @@ It focuses mainly on audio configuration as it might be the most tricky part dep
|
|||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Knowing what you want to play and the involved equipment
|
- Knowing what you want to play and the involved equipment
|
||||||
|
- Basic knowledge about your DAW (how to access its settings, add a plugin, manage tracks inputs and outputs)
|
||||||
- A computer running **Windows** or **macOS**[^1]
|
- A computer running **Windows** or **macOS**[^1]
|
||||||
- A bit of free time to read this guide carefully
|
- A bit of free time to read this guide carefully
|
||||||
|
|
||||||
We will use [OBS Studio](https://obsproject.com/) as our streaming software but you are not required to know how to use it.
|
We will use [OBS Studio](https://obsproject.com/) as our streaming software but you are not required to know how to use it.
|
||||||
|
|
||||||
## How to use this guide?
|
## How to use this guide?
|
||||||
Start by..
|
Simply follow the parts in the correct order! All parts can always be reached through the navigation side bar on the left.
|
||||||
|
|
||||||
Then...
|
Start by part [1. Which audio setup do I use?](audio/readme.md) that will help you to figure out which instructions you should follow to configure your audio.
|
||||||
|
|
||||||
And voilà.
|
Before actually configuring your audio you should first follow [a super fast introduction to OBS (part 2)](obs.md), then configure the video in OBS [part 3](video.md).
|
||||||
|
|
||||||
|
Then come the main point of this guide: the [audio configuration (part 4)](audio/README.md)
|
||||||
|
|
||||||
|
You will then have to configure OBS to make it [stream to your favorite platform (part 5)](streaming.md)
|
||||||
|
|
||||||
## Why I wrote this guide?
|
## Why I wrote this guide?
|
||||||
It began during the COVID-19 lockdown. During this period we saw many initiatives (online festivals, groups, personal projects) aiming to live stream artists and musicians performing from their home.
|
It began during the COVID-19 lockdown. During this period we saw many initiatives (online festivals, groups, personal projects) aiming to live stream artists and musicians performing from their home.
|
||||||
@@ -25,4 +30,4 @@ I got somehow involved in some of these projects and saw the lack of information
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[^1]Sorry dear Linux user, I have no specific instructions for you, but you might still find this guide useful!
|
[^1]Sorry dear Linux user, I have no specific instructions for you, but you might still find this guide useful! Solution logics are the same but you will have to find compatible alternative softwares by yourself. Have a look at [Jack Audio](https://jackaudio.org/) or [Pulse Audio](https://www.freedesktop.org/wiki/Software/PulseAudio/)
|
||||||
|
@@ -14,3 +14,10 @@
|
|||||||
* [Case 4: OBS + OBS-ASIO (Windows only)](audio/obsasio.md)
|
* [Case 4: OBS + OBS-ASIO (Windows only)](audio/obsasio.md)
|
||||||
* [Case 5: OBS + OBS-ASIO + ASIO mixer (Windows only)](audio/asiomixer.md)
|
* [Case 5: OBS + OBS-ASIO + ASIO mixer (Windows only)](audio/asiomixer.md)
|
||||||
* [Case 6: OBS + BlackHole (macOS only)](audio/blackhole.md)
|
* [Case 6: OBS + BlackHole (macOS only)](audio/blackhole.md)
|
||||||
|
* [5. Streaming configuration](streaming.md)
|
||||||
|
* [Testing your internet connection](streaming.md#testing-your-internet-connection)
|
||||||
|
* [Choosing a video bitrate](streaming.md#wtf-is-a-bitrate-and-how-do-i-choose-one-)
|
||||||
|
* [Troubleshooting](troubleshooting.md)
|
||||||
|
* [OBS dropping frames](troubleshooting.md#troubleshooting-obs-dropping-frames)
|
||||||
|
* [Audio and video not in sync](troubleshooting.md#troubleshooting-audio-and-video-not-in-sync-in-obs)
|
||||||
|
* [Audio crackles and latency](troubleshooting.md#troubleshooting-audio-crackles-and-latency-issue)
|
||||||
|
@@ -9,4 +9,4 @@ This is by far the hardest case of all, but also the most documented online. I h
|
|||||||
- [Asio Link Pro](https://give.academy/posts/2018/03/02/AsioLinkPro/) (free) should be the most powerful and flexible solution, bu also the hardest to set up (thanks to a 20 years old GUI). [For the record](https://give.academy/posts/2018/03/02/AsioLinkPro/), it's an old piece of software which you had to pay for. The developer passed away a few years ago so nobody could buy it anymore. In 2019 his nephew decided to create a "legit" crack allowing anyone to use Asio Link Pro for free.
|
- [Asio Link Pro](https://give.academy/posts/2018/03/02/AsioLinkPro/) (free) should be the most powerful and flexible solution, bu also the hardest to set up (thanks to a 20 years old GUI). [For the record](https://give.academy/posts/2018/03/02/AsioLinkPro/), it's an old piece of software which you had to pay for. The developer passed away a few years ago so nobody could buy it anymore. In 2019 his nephew decided to create a "legit" crack allowing anyone to use Asio Link Pro for free.
|
||||||
- [Jack Audio](https://jackaudio.org/downloads/) should be actually simpler to configure even though it does not provide a GUI (graphical user interface). All is done with command lines, but you need very few to get your setup working properly.
|
- [Jack Audio](https://jackaudio.org/downloads/) should be actually simpler to configure even though it does not provide a GUI (graphical user interface). All is done with command lines, but you need very few to get your setup working properly.
|
||||||
|
|
||||||
If all these solutions seem too hard to get through, just go with Case 3.
|
If all these solutions seem too hard to get through, just go with [Case 3](reastream.md).
|
||||||
|
@@ -9,7 +9,7 @@ BlackHole is the new "virtual audio device for macOS" replacement for SoundFlowe
|
|||||||
|
|
||||||
2. Then open "Audio Midi Setup" app located in Applications/Utility. Once opened, click "Window" in the menu bar, then "Show audio devices".
|
2. Then open "Audio Midi Setup" app located in Applications/Utility. Once opened, click "Window" in the menu bar, then "Show audio devices".
|
||||||
|
|
||||||
3. Click the "+" in the bottom left, then "Add a multi-output device"
|
3. Click the ➕ in the bottom left, then "Add a multi-output device"
|
||||||
|
|
||||||
4. Click on the multi-output device you just created, then, depending on your case:
|
4. Click on the multi-output device you just created, then, depending on your case:
|
||||||
- If you uses no external sound card, tick the "Use" box for **each** of the following devices:
|
- If you uses no external sound card, tick the "Use" box for **each** of the following devices:
|
||||||
@@ -22,4 +22,4 @@ BlackHole is the new "virtual audio device for macOS" replacement for SoundFlowe
|
|||||||
|
|
||||||
5. In your audio software, select the Multi-output device you just created as your audio output.
|
5. In your audio software, select the Multi-output device you just created as your audio output.
|
||||||
6. In OBS, open the Preferences/Settings, panel, go to the Audio tab, and select BlackHole as your Desktop Audio device. Click OK.
|
6. In OBS, open the Preferences/Settings, panel, go to the Audio tab, and select BlackHole as your Desktop Audio device. Click OK.
|
||||||
7. You should then see the corresponding VU-meter in the Audio mixer reacting to the audio sent by your audio software. You're done! Ready for part 3.
|
7. You should then see the corresponding VU-meter in the Audio mixer reacting to the audio sent by your audio software. You're done! Ready for part [5. Streaming configuration](../streaming.md).
|
||||||
|
@@ -3,6 +3,8 @@
|
|||||||
You are into Case 2 if:
|
You are into Case 2 if:
|
||||||
> You use Windows with an audio software and MME/DirectX drivers, with or without external sound card.
|
> You use Windows with an audio software and MME/DirectX drivers, with or without external sound card.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
It is as simple as case 1 but with a little variation.
|
It is as simple as case 1 but with a little variation.
|
||||||
|
|
||||||
1. Open your audio software, make it play some sounds, and remember the audio output it's using
|
1. Open your audio software, make it play some sounds, and remember the audio output it's using
|
||||||
@@ -13,4 +15,4 @@ It is as simple as case 1 but with a little variation.
|
|||||||
|
|
||||||
4. Click OK then in the OBS audio mixer you should see the VU-meter of the "Desktop Audio" source moving relatively to the sound your audio software is outputting. Sometimes it seems a big buggy and you need to click the gear ⚙️ of the Desktop Audio source, click Properties, then re-select the same output you just selected in the previous step. You can also try restarting OBS (don't worry, it will automatically save your session).
|
4. Click OK then in the OBS audio mixer you should see the VU-meter of the "Desktop Audio" source moving relatively to the sound your audio software is outputting. Sometimes it seems a big buggy and you need to click the gear ⚙️ of the Desktop Audio source, click Properties, then re-select the same output you just selected in the previous step. You can also try restarting OBS (don't worry, it will automatically save your session).
|
||||||
|
|
||||||
5. Awesome, you are now ready to go to part 3!
|
5. Awesome, you are now ready to go to part [5. Streaming configuration](../streaming.md)!
|
||||||
|
@@ -14,17 +14,19 @@ You are into Case 1 if:
|
|||||||
> - a secondary external sound card with MME/DirectX drivers as a looback input, or
|
> - a secondary external sound card with MME/DirectX drivers as a looback input, or
|
||||||
> - an external sound card with ASIO drivers and you loop your audio back into your built-in computer line-input.
|
> - an external sound card with ASIO drivers and you loop your audio back into your built-in computer line-input.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
If your whole audio come from a microphone, it may be already
|
If your whole audio come from a microphone, it may be already
|
||||||
automatically selected as Mic/Aux source in the audio mixer.
|
automatically selected as Mic/Aux source in the Audio Mixer.
|
||||||
|
|
||||||
If not, you should be able to select it or any appropriate (non ASIO)
|
If not, you should be able to select it or any appropriate (non ASIO)
|
||||||
audio input into OBS Preferences \> "Audio" tab \> "Mic/auxiliary Audio"
|
audio input into the OBS Settings panel, "Audio" tab, "Mic/auxiliary Audio" device.
|
||||||
drop-down list.
|
drop-down list.
|
||||||
|
|
||||||
You can also click the gear near-by the Mic/Aux source in the Audio
|
You can also click the gear ⚙️ near-by the Mic/Aux source in the Audio
|
||||||
Mixer, then click properties and select your correct or audio input in
|
Mixer, then click Properties and select your correct or audio input in
|
||||||
the "Device" drop-down list.
|
the "Device" drop-down list.
|
||||||
|
|
||||||
You should then see the Mix/Aux VU-meter reacting to the captured audio.
|
You should then see the Mix/Aux VU-meter reacting to the captured audio.
|
||||||
If so your audio is properly configured, good! You are now ready for
|
If so your audio is properly configured, good! You are now ready for
|
||||||
part 3.
|
part [5. Streaming configuration](../streaming.md).
|
||||||
|
@@ -11,7 +11,7 @@ You are in case 4 if:
|
|||||||
|
|
||||||
4. Re-open OBS.
|
4. Re-open OBS.
|
||||||
|
|
||||||
5. Click the "+" in the Sources window, and select "ASIO" to create a new ASIO source. Give it the name you want and click OK.
|
5. Click the ➕ in the Sources window, and select "ASIO" to create a new ASIO source. Give it the name you want and click OK.
|
||||||
|
|
||||||
6. In the appearing window, choose your ASIO device:
|
6. In the appearing window, choose your ASIO device:
|
||||||
- If you use an external sound card with a built-in loopback feature or if you physically hard-wired an audio input of your external sound car back into one of its inputs, then choose this external sound cards driver
|
- If you use an external sound card with a built-in loopback feature or if you physically hard-wired an audio input of your external sound car back into one of its inputs, then choose this external sound cards driver
|
||||||
@@ -20,4 +20,4 @@ You are in case 4 if:
|
|||||||
|
|
||||||
7. Choose "Stereo" in the Format field
|
7. Choose "Stereo" in the Format field
|
||||||
8. In OBS Channels 1 and 2 (stands for left and right channels), select the appropriate ASIO inputs you looped your audio back into.
|
8. In OBS Channels 1 and 2 (stands for left and right channels), select the appropriate ASIO inputs you looped your audio back into.
|
||||||
9. Click OK then in the OBS Audio Mixer you should see the VU-meter of the created ASIO source moving relatively to the sound your audio software is outputting. If so, you are good to go to part 3!
|
9. Click OK then in the OBS Audio Mixer you should see the VU-meter of the created ASIO source moving relatively to the sound your audio software is outputting. If so, you are good to go to part [5. Streaming configuration](../streaming.md)!
|
||||||
|
@@ -3,42 +3,46 @@
|
|||||||
You are into Case 3 if:
|
You are into Case 3 if:
|
||||||
> You use Windows with an audio software and ASIO drivers, with or without external sound card.
|
> You use Windows with an audio software and ASIO drivers, with or without external sound card.
|
||||||
|
|
||||||
This case work for any kind of ASIO driver, regardless the use of an external sound card or not.
|
This case work for any kind of ASIO driver, regardless the use of an external sound card or not. It can actually work also with any other kind of driver (MME/DirectX/WASAPI) but you should rather refer to [Case 2: OBS + Desktop Audio Source](desktopaudio.md) if you use one of those.
|
||||||
|
|
||||||
1. ReaStream is included in a suite of free plugins called ReaPlugs VST FX Suite you can download [here](https://www.reaper.fm/reaplugs/). Choose the 32bit or 64bit version depending on your audio software (Ableton Live 10 is 64bit only, other might depend).
|
---
|
||||||
|
|
||||||
2. Run the installer. In the "Choose Components" screen, you only need ReaStream (stereo) but you can select other plugins if you want to try them.
|
The following instructions are based on ReaStream, a VST plugin made to send audio and midi in real time over a local network. Here we will use it on a same comuter as a bridge between your DAW and OBS.
|
||||||
|
|
||||||
3. In the "Destination Folder", make sure you are using one of the [following](https://github.com/obsproject/obs-studio/wiki/Filters-Guide#vst-plugin) (see list below), otherwise the VST wont be available in OBS. Click Install and you're done. If you usually use a custom folder for your VSTs, just re-install ReaStream to your custom folder once you got it installed in one recognized by OBS:
|
1. ReaStream is included in a suite of free plugins called ReaPlugs VST FX Suite you can download [here](https://www.reaper.fm/reaplugs/). Choose the 32bit or 64bit version depending on your audio software (Ableton Live 10 is 64bit only, other might depend).
|
||||||
- C:/Program Files/Steinberg/VstPlugins/
|
|
||||||
- C:/Program Files/Common Files/Steinberg/Shared Components/
|
|
||||||
- C:/Program Files/Common Files/VST2
|
|
||||||
- C:/Program Files/Common Files/VSTPlugins/
|
|
||||||
- C:/Program Files/VSTPlugins/
|
|
||||||
|
|
||||||
4. Open your audio software and add the "reastream-standalone" VST plugin on your master track. You should see a firewall alert saying that the plugin want to access your network. Just allow it on both private and public networks, just in case, and click OK. Now on the plug-ins interface, select "Send audio/MIDI" then choose/type "\*local broadcast" (without quotation marks) in the IP field.
|
2. Run the installer. In the "Choose Components" screen, you only need ReaStream (stereo) but you can select other plugins if you want to try them.
|
||||||
|
|
||||||
5. Open OBS, click the "+" in the Sources window and select "Audio **input** capture". Give it any name you want, and click OK.
|
3. In the "Destination Folder", make sure you are using one of the [following](https://github.com/obsproject/obs-studio/wiki/Filters-Guide#vst-plugin) (see list below), otherwise the VST wont be available in OBS. Click Install and you're done. If you usually use a custom folder for your VSTs, just re-install ReaStream to your custom folder once you got it installed in one recognized by OBS:
|
||||||
|
- C:/Program Files/Steinberg/VstPlugins/
|
||||||
|
- C:/Program Files/Common Files/Steinberg/Shared Components/
|
||||||
|
- C:/Program Files/Common Files/VST2
|
||||||
|
- C:/Program Files/Common Files/VSTPlugins/
|
||||||
|
- C:/Program Files/VSTPlugins/
|
||||||
|
|
||||||
6. As Device, choose an audio input you are NOT using. We actually don't care of the audio input itself, as we want the audio coming from the VST we will add in the next steps. So just use an unused audio input. If you can only select some used inputs (such as your default microphone), then is is still OK, we will figure it out later. Click OK.
|
4. Open your audio software and add the **reastream-standalone** VST plugin on your master track. You should see a firewall alert saying that the plugin want to access your network. Just allow it on both private and public networks, just in case, and click OK. Now on the plug-ins interface, select "Send audio/MIDI" then choose/type `\*local broadcast` (without quotation marks) in the IP field.
|
||||||
|
|
||||||
7. Now right click on your newly created audio input capture source, and select "Filters".
|
5. Open OBS, click the ➕ in the Sources window and select "Audio **input** capture". Give it any name you want, and click OK.
|
||||||
|
|
||||||
8. If you had no unused audio input available, you want to turn down the volume of your used audio input without turning down the volume of the OBS audio source itself. To do so, add two "Gain" Filters and set them to -30dB.
|
6. As Device, choose an audio input you are NOT using. We actually don't care of the audio input itself, as we want the audio coming from the VST we will add in the next steps. So just use an unused audio input. If you can only select some used inputs (such as your default microphone), then is is still OK, we will figure it out later. Click OK.
|
||||||
|
|
||||||
9. Ad a new audio filter by clicking the +, and select "VST 2.x Plug-in". Give it the name you want and click OK.
|
7. Now right click on your newly created audio input capture source, and select "Filters".
|
||||||
|
|
||||||
10. In the VST 2.x Plug-in drop-down list, select "reastream-standalone", then click "Open Plug-in Interface". Windows should prompt you again the firewall security message. Just allow everything one more time.
|
8. If you had no unused audio input available, you want to turn down the volume of your used audio input without turning down the volume of the OBS audio source itself. To do so, add two "Gain" Filters and set them to -30dB.
|
||||||
|
|
||||||
11. Make sure the Identifier is the same as the one you set in Ableton ("default" by default), and you're done.
|
9. Ad a new audio filter by clicking the +, and select "VST 2.x Plug-in". Give it the name you want and click OK.
|
||||||
|
|
||||||
12. Now if you play some sound in your audio software you should get it into your OBS audio input capture device. If so, you're good to go to part 3. If not, see below for some troubleshooting.
|
10. In the VST 2.x Plug-in drop-down list, select "reastream-standalone", then click "Open Plug-in Interface". Windows should prompt you again the firewall security message. Just allow everything one more time.
|
||||||
|
|
||||||
|
11. Make sure the Identifier is the same as the one you set in Ableton ("default" by default), and you're done.
|
||||||
|
|
||||||
|
12. Now if you play some sound in your audio software you should get it into your OBS audio input capture device. If so, you're good to go to part [5. Streaming configuration](../streaming.md). If not, see below for some troubleshooting.
|
||||||
|
|
||||||
What to do if ReaStream in OBS do not receive sound from my audio software?
|
What to do if ReaStream in OBS do not receive sound from my audio software?
|
||||||
|
|
||||||
- Make sure you are using the same sample rate (44.1Khz or 48KHz) in your audio software and OBS (Settings \> Audio tab)
|
- Make sure you are using the same sample rate (44.1Khz or 48KHz) in your audio software and OBS (Settings \> Audio tab)
|
||||||
- Right click the Audio input capture, open "Properties" then select another input device. For some reasons, it might not work with some devices (especially the "Default" one).
|
- Right click the Audio input capture, open "Properties" then select another input device. For some reasons, it might not work with some devices (especially the "Default" one).
|
||||||
- In ReaStream in your audio software, replace "\* local broadcast" by "127.0.0.1". It is a special IP address saying "this very own computer".
|
- In ReaStream in your audio software, replace `* local broadcast` by `127.0.0.1`. It is a special IP address saying "this very own computer".
|
||||||
- Try changing to another identifier in both OBS and your audio software. Sometimes, just clicking in the Identifier field and hitting "Enter" can re-instanciate the plugin an make it work.
|
- Try changing to another identifier in both OBS and your audio software. Sometimes, just clicking in the Identifier field and hitting "Enter" can re-instanciate the plugin an make it work.
|
||||||
|
|
||||||
What to do you it seem like there is some latency between the received audio in OBS and the captured video? Just check the "**delay between your video and audio**" point in the "Troubleshooting audio issues" part below.
|
What to do you it seem like there is some latency between the received audio in OBS and the captured video? Just check the related [troubleshooting part](troubleshooting.md#troubleshooting-audio-and-video-not-in-sync-in-obs) of this guide.
|
||||||
|
1
node_modules/.bin/katex
generated
vendored
Symbolic link
1
node_modules/.bin/katex
generated
vendored
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../katex/cli.js
|
28
node_modules/gitbook-plugin-katex/.npmignore
generated
vendored
Normal file
28
node_modules/gitbook-plugin-katex/.npmignore
generated
vendored
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
|
||||||
|
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directory
|
||||||
|
# Commenting this out is preferred by some people, see
|
||||||
|
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
|
||||||
|
node_modules
|
||||||
|
|
||||||
|
# Users Environment Variables
|
||||||
|
.lock-wscript
|
201
node_modules/gitbook-plugin-katex/LICENSE
generated
vendored
Normal file
201
node_modules/gitbook-plugin-katex/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright {yyyy} {name of copyright owner}
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
35
node_modules/gitbook-plugin-katex/README.md
generated
vendored
Normal file
35
node_modules/gitbook-plugin-katex/README.md
generated
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
Math typesetting using KaTex
|
||||||
|
==============
|
||||||
|
|
||||||
|
Use it for your book, by adding to your book.json:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"plugins": ["katex"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
then run `gitbook install`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
Inline math: $$\int_{-\infty}^\infty g(x) dx$$
|
||||||
|
|
||||||
|
|
||||||
|
Block math:
|
||||||
|
|
||||||
|
$$
|
||||||
|
\int_{-\infty}^\infty g(x) dx
|
||||||
|
$$
|
||||||
|
|
||||||
|
Or using the templating syntax:
|
||||||
|
|
||||||
|
{% math %}\int_{-\infty}^\infty g(x) dx{% endblock %}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Comparison with [MathJax](https://github.com/GitbookIO/plugin-mathjax)
|
||||||
|
|
||||||
|
- Faster
|
||||||
|
|
35
node_modules/gitbook-plugin-katex/index.js
generated
vendored
Normal file
35
node_modules/gitbook-plugin-katex/index.js
generated
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
var katex = require("katex");
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
book: {
|
||||||
|
assets: "./static",
|
||||||
|
js: [],
|
||||||
|
css: [
|
||||||
|
"katex.min.css"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
ebook: {
|
||||||
|
assets: "./static",
|
||||||
|
css: [
|
||||||
|
"katex.min.css"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
blocks: {
|
||||||
|
math: {
|
||||||
|
shortcuts: {
|
||||||
|
parsers: ["markdown", "asciidoc", "restructuredtext"],
|
||||||
|
start: "$$",
|
||||||
|
end: "$$"
|
||||||
|
},
|
||||||
|
process: function(blk) {
|
||||||
|
var tex = blk.body;
|
||||||
|
var isInline = !(tex[0] == "\n");
|
||||||
|
var output = katex.renderToString(tex, {
|
||||||
|
displayMode: !isInline
|
||||||
|
});
|
||||||
|
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
106
node_modules/gitbook-plugin-katex/package.json
generated
vendored
Normal file
106
node_modules/gitbook-plugin-katex/package.json
generated
vendored
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
{
|
||||||
|
"_args": [
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "gitbook-plugin-katex",
|
||||||
|
"raw": "gitbook-plugin-katex@1.1.4",
|
||||||
|
"rawSpec": "1.1.4",
|
||||||
|
"scope": null,
|
||||||
|
"spec": "1.1.4",
|
||||||
|
"type": "version"
|
||||||
|
},
|
||||||
|
"/Volumes/Atelier/lucil/Documents/_WEB/StreamMusicalPerformance"
|
||||||
|
]
|
||||||
|
],
|
||||||
|
"_from": "gitbook-plugin-katex@1.1.4",
|
||||||
|
"_id": "gitbook-plugin-katex@1.1.4",
|
||||||
|
"_inCache": true,
|
||||||
|
"_installable": true,
|
||||||
|
"_location": "/gitbook-plugin-katex",
|
||||||
|
"_nodeVersion": "8.1.3",
|
||||||
|
"_npmOperationalInternal": {
|
||||||
|
"host": "s3://npm-registry-packages",
|
||||||
|
"tmp": "tmp/gitbook-plugin-katex-1.1.4.tgz_1502894343416_0.2687492223922163"
|
||||||
|
},
|
||||||
|
"_npmUser": {
|
||||||
|
"email": "aaron.omullan@gmail.com",
|
||||||
|
"name": "aarono"
|
||||||
|
},
|
||||||
|
"_npmVersion": "5.0.3",
|
||||||
|
"_phantomChildren": {},
|
||||||
|
"_requested": {
|
||||||
|
"name": "gitbook-plugin-katex",
|
||||||
|
"raw": "gitbook-plugin-katex@1.1.4",
|
||||||
|
"rawSpec": "1.1.4",
|
||||||
|
"scope": null,
|
||||||
|
"spec": "1.1.4",
|
||||||
|
"type": "version"
|
||||||
|
},
|
||||||
|
"_requiredBy": [
|
||||||
|
"#USER"
|
||||||
|
],
|
||||||
|
"_resolved": "https://registry.npmjs.org/gitbook-plugin-katex/-/gitbook-plugin-katex-1.1.4.tgz",
|
||||||
|
"_shasum": "9d323efadd26c3408526c5c227ebdb4c1120d9ac",
|
||||||
|
"_shrinkwrap": null,
|
||||||
|
"_spec": "gitbook-plugin-katex@1.1.4",
|
||||||
|
"_where": "/Volumes/Atelier/lucil/Documents/_WEB/StreamMusicalPerformance",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/GitbookIO/plugin-katex/issues"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"katex": "0.7.1"
|
||||||
|
},
|
||||||
|
"description": "Math typesetting using KaTex into GitBook",
|
||||||
|
"devDependencies": {},
|
||||||
|
"directories": {},
|
||||||
|
"dist": {
|
||||||
|
"integrity": "sha512-eBDcI3Cq2ZJFTbqYu313pg+Xkmf7q8bQLKNJMj0ADFYJKGOFSKf5MvY3TscKDYp57eq/BcUfnH43VX9mdsqo8g==",
|
||||||
|
"shasum": "9d323efadd26c3408526c5c227ebdb4c1120d9ac",
|
||||||
|
"tarball": "https://registry.npmjs.org/gitbook-plugin-katex/-/gitbook-plugin-katex-1.1.4.tgz"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"gitbook": ">=2.0.0"
|
||||||
|
},
|
||||||
|
"gitHead": "85a5f11e6f400705b125bec87909b2ec6efb2822",
|
||||||
|
"homepage": "https://github.com/GitbookIO/plugin-katex",
|
||||||
|
"keywords": [
|
||||||
|
"math",
|
||||||
|
"latex"
|
||||||
|
],
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"main": "index.js",
|
||||||
|
"maintainers": [
|
||||||
|
{
|
||||||
|
"email": "samypesse@gmail.com",
|
||||||
|
"name": "samypesse"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"email": "hello@gabinaureche.com",
|
||||||
|
"name": "zhouzi"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"email": "soreine.plume@gmail.com",
|
||||||
|
"name": "soreine"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"email": "johan.preynat@gmail.com",
|
||||||
|
"name": "jpreynat"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"email": "aaron.omullan@gmail.com",
|
||||||
|
"name": "aarono"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"email": "contact@gitbook.com",
|
||||||
|
"name": "gitbook-bot"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "gitbook-plugin-katex",
|
||||||
|
"optionalDependencies": {},
|
||||||
|
"readme": "ERROR: No README data found!",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/GitbookIO/plugin-katex.git"
|
||||||
|
},
|
||||||
|
"version": "1.1.4"
|
||||||
|
}
|
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.eot
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.eot
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.ttf
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.ttf
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff
generated
vendored
Normal file
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff2
generated
vendored
Normal file
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff2
generated
vendored
Normal file
Binary file not shown.
1
node_modules/gitbook-plugin-katex/static/katex.min.css
generated
vendored
Normal file
1
node_modules/gitbook-plugin-katex/static/katex.min.css
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
27
node_modules/katex/LICENSE.txt
generated
vendored
Normal file
27
node_modules/katex/LICENSE.txt
generated
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2015 Khan Academy
|
||||||
|
|
||||||
|
This software also uses portions of the underscore.js project, which is
|
||||||
|
MIT licensed with the following copyright:
|
||||||
|
|
||||||
|
Copyright (c) 2009-2015 Jeremy Ashkenas, DocumentCloud and Investigative
|
||||||
|
Reporters & Editors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
68
node_modules/katex/README.md
generated
vendored
Normal file
68
node_modules/katex/README.md
generated
vendored
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) [](https://travis-ci.org/Khan/KaTeX)
|
||||||
|
|
||||||
|
[](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
|
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
|
||||||
|
|
||||||
|
* **Fast:** KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in [this speed test](http://jsperf.com/katex-vs-mathjax/).
|
||||||
|
* **Print quality:** KaTeX’s layout is based on Donald Knuth’s TeX, the gold standard for math typesetting.
|
||||||
|
* **Self contained:** KaTeX has no dependencies and can easily be bundled with your website resources.
|
||||||
|
* **Server side rendering:** KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML.
|
||||||
|
|
||||||
|
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css">
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### In-browser rendering
|
||||||
|
|
||||||
|
Call `katex.render` with a TeX expression and a DOM element to render into:
|
||||||
|
|
||||||
|
```js
|
||||||
|
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element);
|
||||||
|
```
|
||||||
|
|
||||||
|
If KaTeX can't parse the expression, it throws a `katex.ParseError` error.
|
||||||
|
|
||||||
|
#### Server side rendering or rendering to a string
|
||||||
|
|
||||||
|
To generate HTML on the server or to generate an HTML string of the rendered math, you can use `katex.renderToString`:
|
||||||
|
|
||||||
|
```js
|
||||||
|
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}");
|
||||||
|
// '<span class="katex">...</span>'
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure to include the CSS and font files, but there is no need to include the JavaScript. Like `render`, `renderToString` throws if it can't parse the expression.
|
||||||
|
|
||||||
|
#### Rendering options
|
||||||
|
|
||||||
|
You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are:
|
||||||
|
|
||||||
|
- `displayMode`: `boolean`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`)
|
||||||
|
- `throwOnError`: `boolean`. If `true`, KaTeX will throw a `ParseError` when it encounters an unsupported command. If `false`, KaTeX will render the unsupported command as text in the color given by `errorColor`. (default: `true`)
|
||||||
|
- `errorColor`: `string`. A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option determines the color which unsupported commands are rendered in. (default: `#cc0000`)
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true });
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Automatic rendering of math on a page
|
||||||
|
|
||||||
|
Math on the page can be automatically rendered using the auto-render extension. See [the Auto-render README](contrib/auto-render/README.md) for more information.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|
32
node_modules/katex/cli.js
generated
vendored
Executable file
32
node_modules/katex/cli.js
generated
vendored
Executable file
@@ -0,0 +1,32 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
// Simple CLI for KaTeX.
|
||||||
|
// Reads TeX from stdin, outputs HTML to stdout.
|
||||||
|
/* eslint no-console:0 */
|
||||||
|
|
||||||
|
var katex = require("./");
|
||||||
|
var input = "";
|
||||||
|
|
||||||
|
// Skip the first two args, which are just "node" and "cli.js"
|
||||||
|
var args = process.argv.slice(2);
|
||||||
|
|
||||||
|
if (args.indexOf("--help") !== -1) {
|
||||||
|
console.log(process.argv[0] + " " + process.argv[1] +
|
||||||
|
" [ --help ]" +
|
||||||
|
" [ --display-mode ]");
|
||||||
|
|
||||||
|
console.log("\n" +
|
||||||
|
"Options:");
|
||||||
|
console.log(" --help Display this help message");
|
||||||
|
console.log(" --display-mode Render in display mode (not inline mode)");
|
||||||
|
process.exit();
|
||||||
|
}
|
||||||
|
|
||||||
|
process.stdin.on("data", function(chunk) {
|
||||||
|
input += chunk.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
process.stdin.on("end", function() {
|
||||||
|
var options = { displayMode: args.indexOf("--display-mode") !== -1 };
|
||||||
|
var output = katex.renderToString(input, options);
|
||||||
|
console.log(output);
|
||||||
|
});
|
68
node_modules/katex/dist/README.md
generated
vendored
Normal file
68
node_modules/katex/dist/README.md
generated
vendored
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) [](https://travis-ci.org/Khan/KaTeX)
|
||||||
|
|
||||||
|
[](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
|
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
|
||||||
|
|
||||||
|
* **Fast:** KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in [this speed test](http://jsperf.com/katex-vs-mathjax/).
|
||||||
|
* **Print quality:** KaTeX’s layout is based on Donald Knuth’s TeX, the gold standard for math typesetting.
|
||||||
|
* **Self contained:** KaTeX has no dependencies and can easily be bundled with your website resources.
|
||||||
|
* **Server side rendering:** KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML.
|
||||||
|
|
||||||
|
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css">
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### In-browser rendering
|
||||||
|
|
||||||
|
Call `katex.render` with a TeX expression and a DOM element to render into:
|
||||||
|
|
||||||
|
```js
|
||||||
|
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element);
|
||||||
|
```
|
||||||
|
|
||||||
|
If KaTeX can't parse the expression, it throws a `katex.ParseError` error.
|
||||||
|
|
||||||
|
#### Server side rendering or rendering to a string
|
||||||
|
|
||||||
|
To generate HTML on the server or to generate an HTML string of the rendered math, you can use `katex.renderToString`:
|
||||||
|
|
||||||
|
```js
|
||||||
|
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}");
|
||||||
|
// '<span class="katex">...</span>'
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure to include the CSS and font files, but there is no need to include the JavaScript. Like `render`, `renderToString` throws if it can't parse the expression.
|
||||||
|
|
||||||
|
#### Rendering options
|
||||||
|
|
||||||
|
You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are:
|
||||||
|
|
||||||
|
- `displayMode`: `boolean`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`)
|
||||||
|
- `throwOnError`: `boolean`. If `true`, KaTeX will throw a `ParseError` when it encounters an unsupported command. If `false`, KaTeX will render the unsupported command as text in the color given by `errorColor`. (default: `true`)
|
||||||
|
- `errorColor`: `string`. A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option determines the color which unsupported commands are rendered in. (default: `#cc0000`)
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true });
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Automatic rendering of math on a page
|
||||||
|
|
||||||
|
Math on the page can be automatically rendered using the auto-render extension. See [the Auto-render README](contrib/auto-render/README.md) for more information.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user