git.iko.soy/urbit.org
on ffa18bb help sign in
urbit.org/readme.md
93 lines 3.3 kB history raw
1# Urbit docs
3These are the urbit docs as they appear on [urbit.org](https://urbit.org/docs/).
5We've found it helps to have a clone of the docs on hand in case urbit.org
6experiences high traffic. Follow these steps to get these into your ship:
8## Installation
10First, you'll need a running urbit. Follow our urbit.org [install
11instructions](https://urbit.org/docs/getting-started/).
13### Local install
15In your urbit's Dojo:
17 ~your-urbit:dojo> |mount /=home=
19You can now find your home desk at the path `/path/to/your-urbit/home/`.
21In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
22mounted `%home` desk. You can run the following shell commands (*replacing your
23urbit's home desk path as necessary*):
25 $ git clone https://github.com/urbit/docs.git
26 $ cd ./docs/
27 $ cp -r ./docs* /path/to/your-urbit/home/web/
29Your Clay filesystem should acknowledge the newly added files.
31Lastly, if make sure you're serving your home desk's `web` directory to the web
32by running the following Dojo command:
34 ~your-urbit:dojo> |serve /=home=/web
36## Get started!
38And now your docs are live! View them at:
40 http://localhost:8080/~~/docs
42> If you're running multiple ships locally, your port number will be `8081`,
43 `8082`, and so on. Check your Dojo output for the correct local port of
44 your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
45 instead for live-network ships. You can also replace `localhost` with the IP
46 of your instance, if you're running your urbit in the cloud.
48## Building the docs with |static
50**note** This instructions are for use with the the [release-candidate branch](https://github.com/urbit/arvo/tree/release-candidate)
51of Arvo.
53Arvo comes with a built-in static site generator, which is very useful for
54exporting sites and pages built with udon, sail, html, markdown or some
55combination of these. Combinations like these docs that you're reading!
57In order to build the docs into a static site, do the following.
59Make sure that you've mounted your ship to your filesystem, but running the following
60in your Dojo.
62> ~ship:dojo>|mount /===
64Then, copy these docs into the pier of a booted ship. It is very important that
65copy the docs into the exact directory indicated in your pier.
67> $ cp -r . <ship-name>/home/web/static-site
69Now, run the static site generator on your urbit ship.
71> ~ship:dojo>|static
73You can now navigate to the output director and run a webserver to view your built docs.
75> $ cd <ship-name>/.urb/put/web/static-site
76> $ python -m SimpleHTTPServer
78Visit `localhost:8000` to see the built docs. Rerun `|static` to build docs and
79see changes.
81## Learn a lot, and have fun!
83People are always around on
84[Talk](https://urbit.org/docs/learn/arvo/arvo-internals/messaging/) and
85[Fora](https://fora.urbit.org/) to answer your questions. Help each other
86out, and don't hesitate if you have an idea for a docs improvement. We'd love if
87the docs themselves became an Urbit community project.
89## Contributing / Feedback
91Give us feedback [on Fora](https://fora.urbit.org/) on how we can make the
92docs better. Let us know about your ideas, requests, and/or problems and we'll
93try and get back to you quickly. Pull requests are more than welcome.