aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-30 11:03:02 +0100
committerGravatar Mark Griffiths <mark@thebespokepixel.com>2014-08-30 11:03:02 +0100
commit2445ac4a536690c80ed8ec059c134cc2683e60e7 (patch)
treeb15593fec36411342b3182b516f35207c68c66df /doc_src
parent3d29cc86366a74021d074c824df248bf77a12221 (diff)
Addition of 'ascii fish' logo
+ small fixes
Diffstat (limited to 'doc_src')
-rw-r--r--doc_src/FORMATTING.md8
-rw-r--r--doc_src/ascii_fish.pngbin8739 -> 23960 bytes
-rw-r--r--doc_src/faq.hdr18
-rw-r--r--doc_src/index.hdr.in1
-rw-r--r--doc_src/tutorial.hdr1
-rw-r--r--doc_src/user_doc.css27
6 files changed, 29 insertions, 26 deletions
diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md
index 74b530a4..20fb35eb 100644
--- a/doc_src/FORMATTING.md
+++ b/doc_src/FORMATTING.md
@@ -60,9 +60,13 @@ which is then transformed by Doxygen into an HTML version (`make user_doc`):
`<span class="command">echo</span> <span class="argument">hello</span> <span class="argument">world</span>`
-A man page version (`make share/man`): __echo__ hello world
+A man page version (`make share/man`):
-And a simple HTML version for the developer docs (`make doc` and `make doc/refman.pdf`): `echo hello world`
+__echo__ hello world
+
+And a simple HTML version for the developer docs (`make doc`) and the LATEX/PDF manual (`make doc/refman.pdf`):
+
+`echo hello world`
### Choosing a CLI style: using a \\fish{style} block
diff --git a/doc_src/ascii_fish.png b/doc_src/ascii_fish.png
index 20151f96..33765a4a 100644
--- a/doc_src/ascii_fish.png
+++ b/doc_src/ascii_fish.png
Binary files differ
diff --git a/doc_src/faq.hdr b/doc_src/faq.hdr
index fd3ed976..22c323d3 100644
--- a/doc_src/faq.hdr
+++ b/doc_src/faq.hdr
@@ -36,7 +36,7 @@
Use the <a href="commands.html#set">`set`</a> command:
-\fish
+\fish{cli-dark}
set -x key value
set -e key
\endfish
@@ -51,7 +51,7 @@ Edit the file `~/.config/fish/config.fish`, creating it if it does not exist (No
The prompt is the output of the `fish_prompt` function. Put it in `~/.config/fish/functions/fish_prompt.fish`. For example, a simple prompt is:
-\fish
+\fish{cli-dark}
function fish_prompt
set_color $fish_color_cwd
echo -n (prompt_pwd)
@@ -72,7 +72,7 @@ Type some part of the command, and then hit the @cursor_key{&uarr;,up} or @curso
`fish` uses parentheses for subcommands. For example:
-\fish
+\fish{cli-dark}
for i in (ls)
echo $i
end
@@ -94,7 +94,7 @@ Use the `env` command.
You can also declare a local variable in a block:
-\fish
+\fish{cli-dark}
begin
set -lx SOME_VAR 1
command
@@ -137,7 +137,7 @@ The `open` command uses the MIME type database and the `.desktop` files used by
If you installed fish manually (e.g. by compiling it, not by using a package manager), you first need to add fish to the list of shells by executing the following command (assuming you installed fish in /usr/local) as root:
-\fish
+\fish{cli-dark}
echo /usr/local/bin/fish >>/etc/shells
\endfish
@@ -145,7 +145,7 @@ If you installed a prepackaged version of fish, the package manager should have
In order to change your default shell, type:
-\fish
+\fish{cli-dark}
chsh -s /usr/local/bin/fish
\endfish
@@ -160,7 +160,7 @@ Quick answer:
Run the following command in fish:
-\fish
+\fish{cli-dark}
echo 'function fish_title;end' > ~/.config/fish/config.fish
\endfish
@@ -177,7 +177,7 @@ Note that fish has a default titlebar message, which will be used if the fish_ti
Change the value of the variable `fish_greeting` or create a `fish_greeting` function. For example, to remove the greeting use:
-\fish
+\fish{cli-dark}
set fish_greeting
\endfish
@@ -207,7 +207,7 @@ Should you wish to uninstall fish, first ensure fish is not set as your shell. R
Next, do the following (assuming fish was installed to /usr/local):
-\fish
+\fish{cli-dark}
rm -Rf /usr/local/etc/fish /usr/local/share/fish ~/.config/fish
rm /usr/local/share/man/man1/fish*.1
cd /usr/local/bin
diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in
index 32b626d8..b6af3233 100644
--- a/doc_src/index.hdr.in
+++ b/doc_src/index.hdr.in
@@ -2,6 +2,7 @@
\mainpage Documentation
\htmlonly[block]
<div class="fish_left_bar">
+<div class="logo"></div>
<div class="menu docs_menu">
\endhtmlonly
@toc@
diff --git a/doc_src/tutorial.hdr b/doc_src/tutorial.hdr
index a63808e1..173c187b 100644
--- a/doc_src/tutorial.hdr
+++ b/doc_src/tutorial.hdr
@@ -2,6 +2,7 @@
\page tutorial Tutorial
\htmlonly[block]
<div class="fish_left_bar">
+<div class="logo"></div>
<div class="menu tutorial_menu">
\endhtmlonly
- <a href="#tut_why_fish">Why fish?</a>
diff --git a/doc_src/user_doc.css b/doc_src/user_doc.css
index 174c9dff..9d4b9961 100644
--- a/doc_src/user_doc.css
+++ b/doc_src/user_doc.css
@@ -1,7 +1,5 @@
* {
margin: 0;
- -moz-box-sizing: border-box;
- -webkit-box-sizing: border-box;
box-sizing: border-box;
}
html { font-size: 62.5%; }
@@ -15,9 +13,10 @@ body {
overflow: hidden;
}
.logo {
- position: absolute;
- width: 200px;
- height: 135px;
+ width: 210px;
+ height: 147px;
+ margin-left: 2rem;
+ margin-bottom: -3rem;
background-image: url(ascii_fish.png);
}
/*Top site index*/
@@ -25,9 +24,9 @@ body {
font: 500 1.4rem/3.6rem "DejaVuSansCondensed", Roboto, Verdana, "Helvetica Neue", Helvetica, Arial, sans-serif;
border: none;
color: white;
- background-color: #1f2d53;
text-align: center;
position: relative;
+ background-color: #1f2d53;
width: 100%;
height: 3.6rem;
}
@@ -47,21 +46,19 @@ body {
font: 400 1.3rem/2.1rem "DejaVuSans", Roboto, "Helvetica Neue", Helvetica, Arial, sans-serif;
}
.fish_left_bar {
- width: 250px;
+ width: 25rem;
color: white;
font-family: "DejaVuSansCondensed", Roboto, "Helvetica Neue", Helvetica, Arial, sans-serif;
background-color: #1f2d53;
}
-.fish_left_little { width: 200px; }
+.fish_left_little { width: 19rem; }
.fish_right_bar {
- margin-left: 250px;
+ margin-left: 25rem;
margin-right: 0;
padding: 0 3rem;
- -moz-box-shadow: -6px 0 6px 4px black;
- -webkit-box-shadow: -6px 0 6px 4px black;
box-shadow: -0.3rem 0.3rem 1rem #000818;
}
-.fish_right_big { margin-left: 200px; }
+.fish_right_big { margin-left: 19rem; }
.fish_only_bar {
width: 100%;
padding-bottom: 3rem;
@@ -266,7 +263,7 @@ h1 > code, h2 > code, h3 > code {
}
/*Page overrides*/
/*Documentation*/
-.docs_menu { line-height: 2rem }
+.docs_menu { line-height: 2rem; }
.docs_menu > ul > li { position: static; }
.docs_menu > ul ul { margin: 0.6rem 0; }
.docs_menu > ul ul > li { margin-bottom: 0.2rem; }
@@ -279,9 +276,9 @@ h1 > code, h2 > code, h3 > code {
padding: 0 4rem;
}
/*Commands*/
-.commands_menu { line-height: 2rem }
+.commands_menu { line-height: 2rem; }
/*FAQ*/
-.faq_menu { line-height: 2rem }
+.faq_menu { line-height: 2rem; }
.faq_menu > ul li { margin-bottom: 0.6rem; }
/*Licenses*/
.license {