mirror of
https://github.com/gitpitch/gitpitch.git
synced 2024-04-18 07:30:55 +08:00
Coming soon page only.
This commit is contained in:
gitpitch
parent
87a9c9c6be
commit
463e696dd1
|
|
@ -1,125 +0,0 @@
|
|||
# Bibliographies
|
||||
|
||||
The [Cite Widget](#add-citations) can be used to add citations to any GitPitch slide deck. When citations are added a bibliography is automatically generated for the slide deck. Bibliographies are generated using existing BibTEX, EndNote, or RIS databases.
|
||||
|
||||
This guide describes how you can add citations to your slide decks:
|
||||
|
||||
- [BibTEX, EndNote, RIS Databases](#register-database)
|
||||
- [Citations Markdown Widget](#add-citations)
|
||||
- [Customize Bibliography Pages](#bibliography-pages)
|
||||
- [Customize Bibliography Fonts](#bibliography-fonts)
|
||||
- [Recommendations for Desktop](#desktop-tip)
|
||||
|
||||
|
||||
|
||||
### Register Database
|
||||
|
||||
Download your BibTEX, EndNote, or RIS database file and add it as an asset depedency for your slide deck. For example, the following directory structure shows a sample slide deck using a sample **books.bib** BibTEX database:
|
||||
|
||||
|
||||
```text
|
||||
.
|
||||
├── assets
|
||||
│ ├── css
|
||||
│ │ └── PITCHME.css
|
||||
│ │
|
||||
│ ├── citations
|
||||
│ │ └── books.bib
|
||||
│ │
|
||||
│ └── img
|
||||
│ └── logo.png
|
||||
│
|
||||
├── PITCHME.md
|
||||
└── PITCHME.yaml
|
||||
```
|
||||
|
||||
The following [PITCHME.yaml](/conventions/pitchme-yaml.md) snippet shows how the `citations-db` setting can be used to register your custom database:
|
||||
|
||||
```yaml
|
||||
citations-db : assets/citations/books.bib
|
||||
```
|
||||
|
||||
The following database file name and file size conventions are enforced:
|
||||
|
||||
- BibTEX database files must use the `.bib` extension
|
||||
- EndNote database files must use the `.enl` extension
|
||||
- RIS database files must use the `.ris` extension
|
||||
- Registered database files must not exceed 1Mb in size
|
||||
|
||||
### Add Citations
|
||||
|
||||
You can add a citation alongside text on any slide using `@cite[cid]` markdown widget syntax. The *cid* value is a citation identifier matching a record in your [BibTEX, EndNote, or RIS Database](#register-database).
|
||||
|
||||
The following markdown snippet shows citations added alongside sample markdown list items:
|
||||
|
||||
```markdown
|
||||
- The Tex Book @cite[texbook]
|
||||
- The LaTeX Companion @cite[latex:companion]
|
||||
- Literate Programming @cite[knuth:1984]
|
||||
- Computer Typesetting @cite[lesk:1977]
|
||||
- LaTex: a Document Preparation System @cite[latex2e]
|
||||
```
|
||||
|
||||
This sample markdown snippet renders as follows:
|
||||
|
||||
|
||||
|
||||
Each citation becomes a hyperlink to a bibliography slide that is automatically generated and appended to the end of your slide deck.
|
||||
|
||||
### Bibliography Pages
|
||||
|
||||
By default the generated bibliography slide renders using the following conventions:
|
||||
|
||||
1. The default title text appearing on the slide is **Bibliography**
|
||||
1. The default number of bibliographic entries per slide is **10**
|
||||
|
||||
|
||||
|
||||
You can override these default conventions using the `citations-page-title` and `citations-page-size` settings respectively. For example:
|
||||
|
||||
```yaml
|
||||
citations-db : assets/citations/books.bib
|
||||
citations-page-title : "Further Reading"
|
||||
citations-page-size : 14
|
||||
```
|
||||
|
||||
### Bibliography Fonts
|
||||
|
||||
By default the generated bibliography renders using the following CSS styles:
|
||||
|
||||
```css
|
||||
/* Bibliography Page Title Style */
|
||||
h4.csl-references {
|
||||
font-size: 30px;
|
||||
font-weight: bold;
|
||||
font-family: "Ubuntu";
|
||||
}
|
||||
|
||||
/* Bibliography Entry Style */
|
||||
div.csl-entry {
|
||||
font-size: 20px;
|
||||
font-family: "Ubuntu";
|
||||
padding-bottom: 20px;
|
||||
}
|
||||
|
||||
/* Bibliography Entry Index Style */
|
||||
div.csl-left-margin {
|
||||
padding-right: 6px;
|
||||
}
|
||||
```
|
||||
|
||||
You can override these default style rules to customize the appearance of the bibliography in your slide decks. To overide these default styles simply add your own custom style rules per the [Custom CSS Guide](/theme/custom-css.md).
|
||||
|
||||
### Desktop Tip
|
||||
|
||||
Processing citations within your [PITCHME.md](/conventions/pitchme-md.md) and auto-generating a bibliography slide is a compute intensive task. The time spent on this task can impact the auto-refresh responsiveness of [GitPitch Desktop](desktop/) when developing slide content.
|
||||
|
||||
If the auto-refresh feature of the Desktop app is heavily impacted for a slide deck using citations then it is recommended that during slide content development you temporarily disable the `citations-db` setting in your [PITCHME.yaml](/conventions/pitchme-yaml.md).
|
||||
|
||||
The best way to tempoarily disable this setting is to comment it out as follows:
|
||||
|
||||
```yaml
|
||||
# citations-db : assets/citations/book.bib
|
||||
```
|
||||
|
||||
If you do temporarily disable this setting do remember to activate it again to verify your citations and bibliography are working as expected before [publishing the slide deck](/cloud/).
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
# PITCHME.md
|
||||
|
||||
If you have ever worked on GitHub, GitLab, or Bitbucket you may be familiar with the **README.md** convention. Any README.md markdown file found within a Git repository is automatically rendered as nicely formatted documentation. This convention gives developers a simple and convenient way to document any project.
|
||||
|
||||
GitPitch introduces a brand new convention called the **PITCHME.md** convention. Any PITCHME.md markdown file found within a Git repository is automatically rendered by [GitPitch Desktop](/desktop/) and the [GitPitch Cloud](/cloud/) as a modern, responsive slideshow presentation.
|
||||
|
||||
The PITCHME.md convention gives developers a uniquely powerful way to develop, manage, and publish slide decks and training materials using best practices under Git version control.
|
||||
|
||||
!> PITCHME.md markdown files also support modular markdown [includes, injection and templates](/modular-markdown/).
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# PITCHME.yaml
|
||||
|
||||
GitPitch slide decks are developed using standard [markdown](/text/basics.md) and powerful [widget syntax](/grid-layouts/native-widgets.md). Beyond markdown itself, the appearance and behavior of slide decks can be manipulated using custom settings. By convention, GitPitch custom settings are maintained within a **PITCHME.yaml** file.
|
||||
|
||||
To give you a sense of the kinds of settings found in a PITCHME.yaml file the following snippet demonstrates some sample custom settings:
|
||||
|
||||
```yaml
|
||||
gitpitch: 4.0
|
||||
|
||||
published: true
|
||||
|
||||
theme-override: assets/css/PITCHME.css
|
||||
|
||||
custom-fonts: [
|
||||
"assets/fonts/Inter.woff2",
|
||||
"assets/fonts/YanoneKaffeesatz.woff2"
|
||||
]
|
||||
|
||||
title: "GitPitch 4.0 - Powerpoint for Geeks"
|
||||
```
|
||||
|
||||
Any *settings* that are directly related to a specific feature are documented directly in the corresponding feature guide. A few standalone settings are also supported. These standalone settings are documented in the [Settings Guide](/settings/).
|
||||
|
||||
### Setting Policies
|
||||
|
||||
[YAML Policy](../_snippets/yaml-public-policy.md ':include')
|
||||
|
||||
[YAML Policy](../_snippets/yaml-private-policy.md ':include')
|
||||
|
||||
For details about publishing slide decks using private repos see the [Cloud Publishing Guide](/cloud/).
|
||||
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
# Slide Delimiters
|
||||
|
||||
To distinguish markdown content on one slide from the next use `---` delimiter syntax. Each delimiter denotes the start of a new slide. For example, this [PITCHME.md](/conventions/pitchme-md) snippet creates 3 distinct slides:
|
||||
|
||||
```markdown
|
||||
# Hello, World!
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
# The End
|
||||
```
|
||||
|
||||
The `---` delimiter syntax creates a series of slides that use (default) horizontal navigation. GitPitch also supports `+++` delimiter syntax that supports vertical navigation between slides. Try out the following markdown snippet and experiment with a mix of horizontal and veritical navigation within your slide deck:
|
||||
|
||||
```markdown
|
||||
# Hello, World!
|
||||
|
||||
---
|
||||
|
||||
# Greetings
|
||||
|
||||
+++
|
||||
|
||||
# Hello
|
||||
|
||||
+++
|
||||
|
||||
# Hola
|
||||
|
||||
+++
|
||||
|
||||
# Namaste
|
||||
|
||||
---
|
||||
|
||||
# The End
|
||||
```
|
||||
|
||||
Typically horizontal navigation is used to present top-level information. Vertical navigation is optional. But is often used to drill-down into details.
|
||||
|
||||
?> As a conference speaker *vertical* slides may be your *time-permitting* slides. As an educator *veritcal* slides may be used to provide reference materials supporting the core slide content.
|
||||
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
# Meet the GitPitch Family
|
||||
|
||||
### About Me
|
||||
|
||||
Hi, I'm David. The solo founder and developer of GitPitch. I've been flipping bits for over 30 years. Working on everything from Linux kernel device drivers, the Java library and virtual machine at Sun Microsystems, to cardiac medical systems at startups, and big data analytics engines acquired by Microsoft. These days I spend my time crafting all things GitPitch.
|
||||
|
||||
### GitPitch Desktop
|
||||
|
||||
The [Desktop app](/desktop/README.md) is a markdown presentation tool delivered using [Docker Desktop](https://www.docker.com/products/docker-desktop) available on MacOS, Linux, and Windows 10. The desktop app lets you develop, preview, present, and publish slide decks.
|
||||
|
||||
### GitPitch.com
|
||||
|
||||
The [GitPitch Cloud](/cloud/README.md) is an online service that works seamlessly with GitPitch Desktop. It lets you publish public, private, and password-protected slide decks on **gitpitch.com**. With nothing more than a simple *git-push* to any GitHub, GitLab, or Bitbucket repository in the cloud.
|
||||
|
||||
### GitPitch Enterprise
|
||||
|
||||
[GitPitch Enterprise](/enterprise/README.md) is a solution for business and education that delivers **gitpitch.com** server functionality for on-premises deployment. A solution optimized for privacy and control. Letting your business get more out of existing Git infrastructure and investment.
|
||||
|
||||
### GitPitch CI/CD
|
||||
|
||||
[GitPitch CI/CD](/cicd/README.md) is a solution for business and education that generates GitPitch PDF, PPTX, and JPG slide screenshots directly within your existing CI/CD pipelines. Like any CI/CD pipeline job, GitPitch CI/CD can be launched in response to events such as a commit, tag, or release on target branches and repositories.
|
||||
|
||||
### GitPitch Open Source
|
||||
|
||||
I began GitPitch as an _open-source_ project in early 2016. That project was developed and maintained on GitHub. While no longer open source, the original project repo is now used to maintain a CHANGELOG alongside the source for these docs. That repo is found [here](https://github.com/gitpitch/gitpitch).
|
||||
|
||||
|
|
@ -1,9 +1,3 @@
|
|||
# Page Not Found
|
||||
# GitPitch 4.0
|
||||
|
||||
It looks like you stumbled up on a link within these docs that is no longer available. Here are a few quick links to get you back to where you need to be:
|
||||
|
||||
- [GitPitch Product Family](/meet-the-family.md)
|
||||
- [GitPitch 4.0 Free Trial](/free-trial.md)
|
||||
- [GitPitch 4.0 What's New?](/whats-new-in-40.md)
|
||||
- [GitPitch 4.0 Desktop App](/desktop/)
|
||||
- [GitPitch 4.0 Cloud Service](cloud/)
|
||||
Coming soon...
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user