Compare commits
8 Commits
49be3994bd
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| 9a35c6d041 | |||
| 4308006224 | |||
| 8a630aa26f | |||
| 577bfafa98 | |||
| a748e9ea03 | |||
| 35a06620ba | |||
| be3c59069f | |||
| b1d42726cc |
8
.gitignore
vendored
8
.gitignore
vendored
@@ -1 +1,7 @@
|
|||||||
_book/*
|
_book/
|
||||||
|
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
.DS_Store
|
||||||
|
.AppleDouble
|
||||||
|
.LSOverride
|
||||||
|
|||||||
@@ -1,2 +1,5 @@
|
|||||||
## DAW
|
## DAW
|
||||||
Your audio software (Ablton Live, Cubase, Logic, Reaper, Bitwig...). More preciselly, a digital audio workstation (DAW) is an electronic device or application software used for recording, editing and producing audio files. *[Source](https://en.wikipedia.org/wiki/Digital_audio_workstation)*
|
Your audio software (Ablton Live, Cubase, Logic, Reaper, Bitwig...). More preciselly, a digital audio workstation (DAW) is an electronic device or application software used for recording, editing and producing audio files. *[Source](https://en.wikipedia.org/wiki/Digital_audio_workstation)*
|
||||||
|
|
||||||
|
## RTMP
|
||||||
|
Stands for Real Time Messaging Protocol. One of the many existing streaming protocols.
|
||||||
|
|||||||
BIN
Guide-streaming-musical-performance.pdf
Normal file
BIN
Guide-streaming-musical-performance.pdf
Normal file
Binary file not shown.
437
LICENSE.md
Normal file
437
LICENSE.md
Normal file
@@ -0,0 +1,437 @@
|
|||||||
|
The content of this project is under license [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||||
|
|
||||||
|
You are free to:
|
||||||
|
- **Share**: copy and redistribute the material in any medium or format
|
||||||
|
- **Adapt**: remix, transform, and build upon the material for any purpose, even commercially.
|
||||||
|
Under the following terms:
|
||||||
|
- **Attribution**: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
|
||||||
|
- **ShareAlike**: If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
|
||||||
|
---
|
||||||
|
|
||||||
|
Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are
|
||||||
|
intended for use by those authorized to give the public
|
||||||
|
permission to use material in ways otherwise restricted by
|
||||||
|
copyright and certain other rights. Our licenses are
|
||||||
|
irrevocable. Licensors should read and understand the terms
|
||||||
|
and conditions of the license they choose before applying it.
|
||||||
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public
|
||||||
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||||
|
License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
|
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||||
|
License"). To the extent this Public License may be interpreted as a
|
||||||
|
contract, You are granted the Licensed Rights in consideration of Your
|
||||||
|
acceptance of these terms and conditions, and the Licensor grants You
|
||||||
|
such rights in consideration of benefits the Licensor receives from
|
||||||
|
making the Licensed Material available under these terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
|
||||||
|
Section 1 -- Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
|
Rights that is derived from or based upon the Licensed Material
|
||||||
|
and in which the Licensed Material is translated, altered,
|
||||||
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
|
permission under the Copyright and Similar Rights held by the
|
||||||
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
|
Material is a musical work, performance, or sound recording,
|
||||||
|
Adapted Material is always produced where the Licensed Material is
|
||||||
|
synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at
|
||||||
|
creativecommons.org/compatiblelicenses, approved by Creative
|
||||||
|
Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
|
closely related to copyright including, without limitation,
|
||||||
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
|
Rights, without regard to how the rights are labeled or
|
||||||
|
categorized. For purposes of this Public License, the rights
|
||||||
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
|
Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the
|
||||||
|
absence of proper authority, may not be circumvented under laws
|
||||||
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name
|
||||||
|
of a Creative Commons Public License. The License Elements of this
|
||||||
|
Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database,
|
||||||
|
or other material to which the Licensor applied this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the
|
||||||
|
terms and conditions of this Public License, which are limited to
|
||||||
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
|
Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
|
under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or
|
||||||
|
process that requires permission under the Licensed Rights, such
|
||||||
|
as reproduction, public display, public performance, distribution,
|
||||||
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright
|
||||||
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
|
as amended and/or succeeded, as well as other essentially
|
||||||
|
equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights
|
||||||
|
under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
|
||||||
|
Section 2 -- Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
|
in part; and
|
||||||
|
|
||||||
|
b. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The
|
||||||
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
|
all media and formats whether now known or hereafter created,
|
||||||
|
and to make technical modifications necessary to do so. The
|
||||||
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. Additional offer from the Licensor -- Adapted Material.
|
||||||
|
Every recipient of Adapted Material from You
|
||||||
|
automatically receives an offer from the Licensor to
|
||||||
|
exercise the Licensed Rights in the Adapted Material
|
||||||
|
under the conditions of the Adapter's License You apply.
|
||||||
|
|
||||||
|
c. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.
|
||||||
|
|
||||||
|
In addition to the conditions in Section 3(a), if You Share
|
||||||
|
Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter's License You apply must be a Creative Commons
|
||||||
|
license with the same License Elements, this version or
|
||||||
|
later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the
|
||||||
|
Adapter's License You apply. You may satisfy this condition
|
||||||
|
in any reasonable manner based on the medium, means, and
|
||||||
|
context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms
|
||||||
|
or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, Adapted Material that restrict exercise of the
|
||||||
|
rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material,
|
||||||
|
|
||||||
|
including for purposes of Section 3(b); and
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses.
|
||||||
|
Notwithstanding, Creative Commons may elect to apply one of its public
|
||||||
|
licenses to material it publishes and in those instances will be
|
||||||
|
considered the “Licensor.” The text of the Creative Commons public
|
||||||
|
licenses is dedicated to the public domain under the CC0 Public Domain
|
||||||
|
Dedication. Except for the limited purpose of indicating that material
|
||||||
|
is shared under a Creative Commons public license or as otherwise
|
||||||
|
permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the public
|
||||||
|
licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
21
README.md
21
README.md
@@ -1,13 +1,20 @@
|
|||||||
# A guide to live stream musical performances from home
|
# A guide to live stream musical performances from home
|
||||||
|
|
||||||
|
V1.0 written by [TFLCL.XYZ](http://tflcl.xyz)
|
||||||
|
|
||||||
|
### Available online [here](https://tflcl.xyz/MusicalPerformanceStreamingGuide/)
|
||||||
|
|
||||||
|
### Contributions are welcome: [github repo](https://github.com/Teufeuleu/StreamingAudioPerformanceGuide)
|
||||||
|
|
||||||
This guide is intended for people wanting to live stream a musical performance from home. It provides informations for most kind of setups, from purely acoustic performances to more complex cases implying a DAW, an external sound card with connected instruments and mics.
|
This guide is intended for people wanting to live stream a musical performance from home. It provides informations for most kind of setups, from purely acoustic performances to more complex cases implying a DAW, an external sound card with connected instruments and mics.
|
||||||
|
|
||||||
It focuses mainly on audio configuration as it might be the most tricky part depending on your setup, although it also includes walkthroughs for all the steps from installing a streaming software to actually start streaming.
|
**It focuses mostly on audio configuration** as it seems to be where most people struggle, although it also includes walkthroughs for all the steps from installing a streaming software to actually start streaming.
|
||||||
|
|
||||||
## 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)
|
- Basic knowledge about your DAW (how to access its settings, add a plugin, manage tracks inputs and outputs)
|
||||||
|
- The streaming platform you are going to use (Twitch, Facebook, Youtube...) and a link to its documentation
|
||||||
- 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
|
||||||
|
|
||||||
@@ -16,18 +23,20 @@ We will use [OBS Studio](https://obsproject.com/) as our streaming software but
|
|||||||
## How to use this guide?
|
## How to use this guide?
|
||||||
Simply follow the parts in the correct order! All parts can always be reached through the navigation side bar on the left.
|
Simply follow the parts in the correct order! All parts can always be reached through the navigation side bar on the left.
|
||||||
|
|
||||||
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.
|
Start by part [a super fast introduction to OBS (part 1)](obs.md) that will help you to install OBS and understand its basis.
|
||||||
|
|
||||||
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).
|
You will then make OBS work with your camera in part [2. Video configuration](video.md)
|
||||||
|
|
||||||
Then come the main point of this guide: the [audio configuration (part 4)](audio/README.md)
|
Then come the main point of this guide: audio configuration. You will first follow part [3. Which audio setup do I use?](setup/README.md) which will lead you to the proper instructions in part [4. Audio configuration](audio/README.md) corresponding to your case.
|
||||||
|
|
||||||
You will then have to configure OBS to make it [stream to your favorite platform (part 5)](streaming.md)
|
You will then have to configure OBS to make it [stream to your favorite platform (part 5)](streaming.md)
|
||||||
|
|
||||||
|
There is also a [Troubleshooting](troubleshooting.md) part that should help you to solve most encountered problems.
|
||||||
|
|
||||||
## 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.
|
||||||
I got somehow involved in some of these projects and saw the lack of information regarding the audio configuration, which can differ A LOT depending on the musical project itself. So I tried to find a solution for most cases and sorting everything properly allowing people to find which case fit their needs and how to do it.
|
I got somehow involved in some of these projects (especially the [Sottkvi festival](https://www.facebook.com/sottkvifestival/))and saw the lack of information regarding the audio configuration, which can differ A LOT depending on the musical project itself. So I tried to find a solution for most cases and sorting everything properly allowing people to find which case fit their needs and how to do it.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[^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/)
|
[^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/).
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# Summary
|
# Summary
|
||||||
|
|
||||||
* [Introduction](README.md)
|
* [Introduction](README.md)
|
||||||
* [1. Which audio setup do I use?](setup/README.md)
|
* [1. A super fast introduction to OBS](obs.md)
|
||||||
|
* [2. Video configuration](video.md)
|
||||||
|
* [3. Which audio setup do I use?](setup/README.md)
|
||||||
* [Acoustic/mic-captured performance](setup/dawless.md)
|
* [Acoustic/mic-captured performance](setup/dawless.md)
|
||||||
* [DAW without external audio interface](setup/daw.md)
|
* [DAW without external audio interface](setup/daw.md)
|
||||||
* [DAW with an external audio interface](setup/dawinterface.md)
|
* [DAW with an external audio interface](setup/dawinterface.md)
|
||||||
* [2. A super fast introduction to OBS](obs.md)
|
|
||||||
* [3. Video configuration](video.md)
|
|
||||||
* [4. Audio configuration](audio/README.md)
|
* [4. Audio configuration](audio/README.md)
|
||||||
* [Case 1: OBS + Mic/Aux Source](audio/micaux.md)
|
* [Case 1: OBS + Mic/Aux Source](audio/micaux.md)
|
||||||
* [Case 2: OBS + Desktop Audio Source](audio/desktopaudio.md)
|
* [Case 2: OBS + Desktop Audio Source](audio/desktopaudio.md)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# 4. Audio configuration
|
# 4. Audio configuration
|
||||||
|
|
||||||
**Please read carefully [1. Which audio setup do I use?](./setup/README.md) to know which of the following case(s) will match your setup.**
|
**Please read carefully [3. Which audio setup do I use?](../setup/README.md) to know which of the following case(s) will match your setup.**
|
||||||
|
|
||||||
- [Case 1: OBS + Mic/Aux source](micaux.md)
|
- [Case 1: OBS + Mic/Aux source](micaux.md)
|
||||||
- [Case 2: OBS + Desktop Audio Source](desktopaudio.md)
|
- [Case 2: OBS + Desktop Audio Source](desktopaudio.md)
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This is by far the hardest case of all, but also the most documented online. I h
|
|||||||
|
|
||||||
- [VoiceMeeter Banana](https://download.vb-audio.com/Download_CABLE/VoicemeeterProSetup.exe) (free) is maybe the most user friendly and most documented solution.
|
- [VoiceMeeter Banana](https://download.vb-audio.com/Download_CABLE/VoicemeeterProSetup.exe) (free) is maybe the most user friendly and most documented solution.
|
||||||
- [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/) (free, open source) 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.
|
||||||
|
- [Synchronous Audio Router](http://sar.audio/) (free, open source) might be another solution.
|
||||||
|
|
||||||
If all these solutions seem too hard to get through, just go with [Case 3](reastream.md).
|
If all these solutions seem too hard to get through, just go with [Case 3](reastream.md).
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ The following instructions are based on ReaStream, a VST plugin made to send aud
|
|||||||
|
|
||||||
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.
|
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 does 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).
|
||||||
|
|||||||
1
node_modules/.bin/katex
generated
vendored
1
node_modules/.bin/katex
generated
vendored
@@ -1 +0,0 @@
|
|||||||
../katex/cli.js
|
|
||||||
28
node_modules/gitbook-plugin-katex/.npmignore
generated
vendored
28
node_modules/gitbook-plugin-katex/.npmignore
generated
vendored
@@ -1,28 +0,0 @@
|
|||||||
# 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
201
node_modules/gitbook-plugin-katex/LICENSE
generated
vendored
@@ -1,201 +0,0 @@
|
|||||||
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
35
node_modules/gitbook-plugin-katex/README.md
generated
vendored
@@ -1,35 +0,0 @@
|
|||||||
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
35
node_modules/gitbook-plugin-katex/index.js
generated
vendored
@@ -1,35 +0,0 @@
|
|||||||
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
106
node_modules/gitbook-plugin-katex/package.json
generated
vendored
@@ -1,106 +0,0 @@
|
|||||||
{
|
|
||||||
"_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
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_AMS-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Bold.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Caligraphic-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Bold.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Fraktur-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Bold.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Italic.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Main-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-BoldItalic.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Italic.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Math-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Bold.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Italic.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_SansSerif-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Script-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size1-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size2-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size3-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Size4-Regular.woff2
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.eot
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.eot
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.ttf
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.ttf
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff
generated
vendored
Binary file not shown.
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff2
generated
vendored
BIN
node_modules/gitbook-plugin-katex/static/fonts/KaTeX_Typewriter-Regular.woff2
generated
vendored
Binary file not shown.
1
node_modules/gitbook-plugin-katex/static/katex.min.css
generated
vendored
1
node_modules/gitbook-plugin-katex/static/katex.min.css
generated
vendored
File diff suppressed because one or more lines are too long
27
node_modules/katex/LICENSE.txt
generated
vendored
27
node_modules/katex/LICENSE.txt
generated
vendored
@@ -1,27 +0,0 @@
|
|||||||
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
68
node_modules/katex/README.md
generated
vendored
@@ -1,68 +0,0 @@
|
|||||||
# [<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
32
node_modules/katex/cli.js
generated
vendored
@@ -1,32 +0,0 @@
|
|||||||
#!/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);
|
|
||||||
});
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user