Giter Club home page Giter Club logo

documentation's Introduction

Welcome to the Raspberry Pi Documentation

This repository contains the Asciidoc source and the toolchain to build the Raspberry Pi Documentation.

NOTE: This repository has undergone some recent changes. See our blog post for more details.

Building the Documentation

Instructions on how to checkout the documentation repo, and then install the toolchain needed to convert from Asciidoc to HTML and build the documentation site.

Checking out the Repository

Install git if you don't already have it, and check out the documentation repo as follows,

$ git clone https://github.com/raspberrypi/documentation.git
$ cd documentation

Installing the Toolchain

On Linux

You can install the necessary dependencies on Linux as follows,

$ sudo apt-get -qq -y install ruby ruby-bundler ruby-dev build-essential python3 git ninja-build

This works on both regular Ubuntu Linux โ€” and has been tested in a minimal Docker container โ€” and also under Raspberry Pi OS if you are working from a Raspberry Pi.

On macOS

If you don't already have it installed you should go ahead and install HomeBrew,

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Then you need to install Ruby,

$ brew install [email protected]

NOTE: Homebrew defaults to Ruby 3.0 which is incompatible with Asciidoctor.

Set up Homebrew Version of Ruby

If you're using csh or tcsh add the following lines to your .cshrc or .tcshrc,

setenv PATH /usr/local/opt/ruby/bin:${PATH}
setenv PATH ${PATH}:/usr/local/lib/ruby/gems/2.7.0/bin
setenv LDFLAGS -L/usr/local/opt/[email protected]/lib
setenv CPPFLAGS -I/usr/local/opt/[email protected]/include
setenv PKG_CONFIG_PATH /usr/local/opt/[email protected]/lib/pkgconfig

or if you're using bash add the following lines to your .bash_profile,

export PATH="/usr/local/opt/ruby/bin:$PATH"
export PATH="$PATH:/usr/local/lib/ruby/gems/2.7.0/bin"
export PATH="/usr/local/opt/[email protected]/bin:$PATH"
export LDFLAGS="-L/usr/local/opt/[email protected]/lib"
export CPPFLAGS="-I/usr/local/opt/[email protected]/include"
export PKG_CONFIG_PATH="/usr/local/opt/[email protected]/lib/pkgconfig"
Install Dependencies

Go ahead and brew install the other dependencies,

$ brew install python@3
$ brew install ninja

Configuring the Repository

After you've installed the toolchain, you'll need to install the required Ruby gems. Make sure you're in the documentation directory and then run,

$ bundle install

Building the Documentation Site

After you've installed the toolchain and configured the repository you can build the documentation with,

$ make

This will automatically convert the build/jekyll/ files to HTML and put them into documentation/html/.

You can also start a local server to view the compiled site by running,

$ make serve_html

As the local server launches, the local URL will be printed in the terminal -- open this URL in a browser to see the locally-built site.

To build without an active internet connection, run

$ OFFLINE_MODE=1 make

which will copy the fonts.html and header.html files from offline_includes (instead of downloading them from esi.raspberrypi.org).

License

The Raspberry Pi documentation is licensed under a Creative Commons Attribution 4.0 International Licence.

documentation's People

Contributors

jamesh65 avatar bennuttall avatar lurch avatar lornalynch avatar lauraclay avatar ghollingworth avatar xecdesign avatar epoch1970 avatar timg236 avatar janinapi avatar thomasschaeferm avatar aisforastronaut avatar jimbojr avatar pelwell avatar lizupton avatar liamfraser avatar asb avatar waveform80 avatar clivebeale avatar phiney0711 avatar dp111 avatar mudge avatar 6by9 avatar teschlg avatar davidhoness avatar gadgetoid avatar ebenupton avatar gbaman avatar timrowledge avatar rbisewski avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.