Documentation stored with source files shares the same permissions. Documentation stored in a separate Git repository can use different access controls. If Gerrit Code Review is being used, branch-level read permissions can be used to grant or restrict access to any documentation branches.
READMEs
Files named README.md
are automatically displayed below the file’s directory listing. For the top-level directory, this mirrors the standard GitHub presentation.
*** Promo README.md files provide orientation for developers browsing the repository, especially first-time users.
We recommend that Git repositories have an up-to-date top-level README.md
file.
Markdown syntax
Gitiles supports the core Markdown syntax described in Markdown Basics. Additional extensions are supported to match GitHub Flavored Markdown more closely and simplify documentation writing.
import Typography from 'typography'
const typography = new Typography({
baseFontSize: '18px',
baseLineHeight: 1.666,
headerFontFamily: ['Avenir Next', 'Helvetica Neue', 'Arial', 'sans-serif'],
bodyFontFamily: ['Georgia', 'serif'],
// See below for the full list of options.
})
// Output CSS as string.
typography.toString()
// Or insert styles directly into the <head> (works well for client-only
// JS web apps.
typography.injectStyles()
<h1>Sample JavaScript</h1>
<div class="gatsby-highlight">
<pre class="language-jsx">
<code>
<!-- Embedded content here ... -->
</code>
</pre>
</div>
<h1>Sample HTML</h1>
<div class="gatsby-highlight">
<pre class="language-html">
<code>
<!-- Embedded content here ... -->
</code>
</pre>
</div>
var rows = prompt('How many rows for your multiplication table?')
var cols = prompt('How many columns for your multiplication table?')
if (rows == '' || rows == null) rows = 10
if (cols == '' || cols == null) cols = 10
createTable(rows, cols)
function createTable(rows, cols) {
var j = 1
var output = "<table border='1' width='500' cellspacing='0'cellpadding='5'>"
for (i = 1; i <= rows; i++) {
output = output + '<tr>'
while (j <= cols) {
output = output + '<td>' + i * j + '</td>'
j = j + 1
}
output = output + '</tr>'
j = 1
}
output = output + '</table>'
document.write(output)
}
Blockquotes
Sir Winston Churchill once said:
A lie gets halfway around the world before the truth has a chance to get its pants on.