Exemplo de uso do GitBook

ExemplodeusodoGitBook
TableofContents
Apresentação
0
Vantagens
1
Primeirospassos
2
Plugins
2.1
1
ExemplodeusodoGitBook
ExemplodeusodoGitBook
EsteéumexemplodeusodoGitBook.TempotencialparaserutilizadonadocumentaçãodosprojetosdoCentrodeTecnologia
Acadêmica,podendoeventualmenteserincluídonoprópriorepositóriodoprojeto.
AseguirsãoapresentadasalgumasvantagensecaracterísticasdoGitBookcomopercebidaspeloautorduranteesteestudo,osprimerios
passosparaousodoGitBookeospluginsinstaladosparaacriaçãodopresenteteste.
ApublicaçãoresultantedestegitbookpodeserencontradaemHTM L,epubepdf.Orepositóriodisponívelaqui.Orepositóriocontém
umscriptdeexemploparaconstruçãodo"livro",suapublicaçãoemHTM Leatualizaçãodoseurepostório.
Figure:LogodoCentrodeTecnologiaAcadêmica-CTAIF/UFRGS
Apresentação
2
ExemplodeusodoGitBook
Vantagens
Controledeversão
SintaxeM arkdowneAsciiDoc
Saídaemdiversosformatos:html,pdf,epub...
FórmulasmatemáticasemTeX:
g(x) = ∫0x f (u)du;
n1
p
+
n2
i
=
n 2 −n1
r
∞
f (x) = ∫
f^(ξ) e2πiξx dξ
−∞
Vantagens
3
ExemplodeusodoGitBook
Primeirospassos
ParautilizaroGitBookvocêprecisaconheceralinguagemdemarcaçãoM arkdown.TambémépossivelutilizarAsciiDoc.Conhecerogit
trásvantagensdecontroledeversão,ediçãocolaborativaefacilidadesdepublicação,masnãoéobrigatório.
ConheçaasintaxeMarkdown
DocumentaçãooriginalsintaxeM arkdown
DocumentaçãoGitBooksintaxeM arkdown
TambémépossívelutilizarAsciiDoc,entretandonãosuportarenderizaçãodeequações.Guiadesintaxepodeserencontradoaqui.
InstaleoGitBook
1. NoDebian(TropOS)Instalarnpmecalibre
(Ocalibrecontémoconversordeformatoebook-converter)
$sudoapt-getinstalnpmcalibre
2. InstalarGitBook
Verreadme.mdnorepositóriooficial
3. Instalarpluginkatexparausodeequaçõesmatemáticas
Instruçõesnorepositóriodoplugin
ListadefunçõesimplementadasnoKaTeX
M athjaxtambémpodeserutilizado,existepluginoficial.
Crieseulivro
Cadagitbookdeveconteraomenosdoisarquivos, README.mde SUMMARY.md:
SUM M ARY.md:ContémaestruturadoLivro;alistadecapítuloseseusrespectivosarquivos.
READM E.md:Introdução/Prefáciodolivro.
Oarquivo book.jsoncontémaconfiguraçãogeraldolivro.Nesteexemplooarquivo book.jsonfoialteradopararemovericones
indesejadas.
ConheçaoGit
Algunsrecursos:
TutoriaisdegitdoSoftwareCarpentry
NoçõesBásicasdeGit-siteoficial
PrimeirospassoscomGit-CentrodeTecnologiaAcadêmica
Primeirospassos
4
ExemplodeusodoGitBook
Plugins
EsteGitBookutilizaospluginslistadosabaixo.Alistadepluginsélidanoarquivo book.json.
Enquantonotasderodapé1 nãoprecisamdeplugins,diversasfuncionalidadesextrassãofornecidasporextensões(plugins2 )para
GitBook.
ImageCaptions
Captionsparaasfiguras.Inclusivenumerando.Verhttps://plugins.gitbook.com/plugin/image-captions.
Superscript
Dáalgumtrabalhoparacolocartextosuperescrito:https://plugins.gitbook.com/plugin/superscript.
Numeraçãodasnotasderodapé
Asnotasderodapépodemsernumeradasgraçasaopluginfootnote-string-to-number.
KaTeXeMathjax
Ospluginskatexemathjaxforamutilizadosparagerarasequaçõesapresentadasnesteexemplo.Enquantoosdoisapresentambons
resultadosparaasaídaemHTM L,oM athjaxapresentoumelhoresresultadosparaoepub,enquantooKatexapresentoumelhores
resultadosparaoPDF.
1
.Notasderodapénãosãonumeradasautomaticamente.Opadrãoéutilizarotextodereferência,porémopluginfootnote-string-
to-numberalteraestecomportamento.Aordemdanumeraçãoseráamesmaordemqueaparecenotexto.↩
2
.https://plugins.gitbook.com/↩
Plugins
5