mirror of
https://github.com/monero-project/monero-docs.git
synced 2025-01-05 02:19:23 +00:00
create just-the-docs project
This commit is contained in:
commit
85cc2502b1
8 changed files with 314 additions and 0 deletions
5
.gitignore
vendored
Normal file
5
.gitignore
vendored
Normal file
|
@ -0,0 +1,5 @@
|
|||
_site
|
||||
.sass-cache
|
||||
.jekyll-cache
|
||||
.jekyll-metadata
|
||||
vendor
|
28
404.html
Normal file
28
404.html
Normal file
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
permalink: /404.html
|
||||
layout: default
|
||||
---
|
||||
|
||||
<style type="text/css" media="screen">
|
||||
.container {
|
||||
margin: 10px auto;
|
||||
max-width: 600px;
|
||||
text-align: center;
|
||||
}
|
||||
h1 {
|
||||
margin: 30px 0;
|
||||
font-size: 4em;
|
||||
line-height: 1;
|
||||
letter-spacing: -1px;
|
||||
}
|
||||
</style>
|
||||
|
||||
<div class="container">
|
||||
<h1>404</h1>
|
||||
|
||||
<p><strong>Page not found.</strong></p>
|
||||
<p>
|
||||
The requested page could not be found. Please take a look at
|
||||
<a href="/#table-of-contents">Table Of Contents</a>.
|
||||
</p>
|
||||
</div>
|
35
Gemfile
Normal file
35
Gemfile
Normal file
|
@ -0,0 +1,35 @@
|
|||
source "https://rubygems.org"
|
||||
# Hello! This is where you manage which Jekyll version is used to run.
|
||||
# When you want to use a different version, change it below, save the
|
||||
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
|
||||
#
|
||||
# bundle exec jekyll serve
|
||||
#
|
||||
# This will help ensure the proper Jekyll version is running.
|
||||
# Happy Jekylling!
|
||||
gem "jekyll", "~> 4.3.3"
|
||||
# This is the default theme for new Jekyll sites. You may change this to anything you like.
|
||||
gem "minima", "~> 2.5"
|
||||
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
|
||||
# uncomment the line below. To upgrade, run `bundle update github-pages`.
|
||||
# gem "github-pages", group: :jekyll_plugins
|
||||
# If you have any plugins, put them here!
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-feed", "~> 0.12"
|
||||
end
|
||||
|
||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
# and associated library.
|
||||
platforms :mingw, :x64_mingw, :mswin, :jruby do
|
||||
gem "tzinfo", ">= 1", "< 3"
|
||||
gem "tzinfo-data"
|
||||
end
|
||||
|
||||
# Performance-booster for watching directories on Windows
|
||||
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
|
||||
|
||||
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
|
||||
# do not have a Java counterpart.
|
||||
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
|
||||
|
||||
gem "just-the-docs"
|
191
Gemfile.lock
Normal file
191
Gemfile.lock
Normal file
|
@ -0,0 +1,191 @@
|
|||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.8.7)
|
||||
public_suffix (>= 2.0.2, < 7.0)
|
||||
bigdecimal (3.1.8)
|
||||
colorator (1.1.0)
|
||||
concurrent-ruby (1.3.3)
|
||||
em-websocket (0.5.3)
|
||||
eventmachine (>= 0.12.9)
|
||||
http_parser.rb (~> 0)
|
||||
eventmachine (1.2.7)
|
||||
ffi (1.17.0)
|
||||
ffi (1.17.0-aarch64-linux-gnu)
|
||||
ffi (1.17.0-aarch64-linux-musl)
|
||||
ffi (1.17.0-arm-linux-gnu)
|
||||
ffi (1.17.0-arm-linux-musl)
|
||||
ffi (1.17.0-arm64-darwin)
|
||||
ffi (1.17.0-x86-linux-gnu)
|
||||
ffi (1.17.0-x86-linux-musl)
|
||||
ffi (1.17.0-x86_64-darwin)
|
||||
ffi (1.17.0-x86_64-linux-gnu)
|
||||
ffi (1.17.0-x86_64-linux-musl)
|
||||
forwardable-extended (2.6.0)
|
||||
google-protobuf (4.27.2)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.27.2-aarch64-linux)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.27.2-arm64-darwin)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.27.2-x86-linux)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.27.2-x86_64-darwin)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.27.2-x86_64-linux)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
http_parser.rb (0.8.0)
|
||||
i18n (1.14.5)
|
||||
concurrent-ruby (~> 1.0)
|
||||
jekyll (4.3.3)
|
||||
addressable (~> 2.4)
|
||||
colorator (~> 1.0)
|
||||
em-websocket (~> 0.5)
|
||||
i18n (~> 1.0)
|
||||
jekyll-sass-converter (>= 2.0, < 4.0)
|
||||
jekyll-watch (~> 2.0)
|
||||
kramdown (~> 2.3, >= 2.3.1)
|
||||
kramdown-parser-gfm (~> 1.0)
|
||||
liquid (~> 4.0)
|
||||
mercenary (>= 0.3.6, < 0.5)
|
||||
pathutil (~> 0.9)
|
||||
rouge (>= 3.0, < 5.0)
|
||||
safe_yaml (~> 1.0)
|
||||
terminal-table (>= 1.8, < 4.0)
|
||||
webrick (~> 1.7)
|
||||
jekyll-feed (0.17.0)
|
||||
jekyll (>= 3.7, < 5.0)
|
||||
jekyll-include-cache (0.2.1)
|
||||
jekyll (>= 3.7, < 5.0)
|
||||
jekyll-sass-converter (3.0.0)
|
||||
sass-embedded (~> 1.54)
|
||||
jekyll-seo-tag (2.8.0)
|
||||
jekyll (>= 3.8, < 5.0)
|
||||
jekyll-watch (2.2.1)
|
||||
listen (~> 3.0)
|
||||
just-the-docs (0.8.2)
|
||||
jekyll (>= 3.8.5)
|
||||
jekyll-include-cache
|
||||
jekyll-seo-tag (>= 2.0)
|
||||
rake (>= 12.3.1)
|
||||
kramdown (2.4.0)
|
||||
rexml
|
||||
kramdown-parser-gfm (1.1.0)
|
||||
kramdown (~> 2.0)
|
||||
liquid (4.0.4)
|
||||
listen (3.9.0)
|
||||
rb-fsevent (~> 0.10, >= 0.10.3)
|
||||
rb-inotify (~> 0.9, >= 0.9.10)
|
||||
mercenary (0.4.0)
|
||||
minima (2.5.1)
|
||||
jekyll (>= 3.5, < 5.0)
|
||||
jekyll-feed (~> 0.9)
|
||||
jekyll-seo-tag (~> 2.1)
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
public_suffix (6.0.0)
|
||||
rake (13.2.1)
|
||||
rb-fsevent (0.11.2)
|
||||
rb-inotify (0.11.1)
|
||||
ffi (~> 1.0)
|
||||
rexml (3.3.2)
|
||||
strscan
|
||||
rouge (4.3.0)
|
||||
safe_yaml (1.0.5)
|
||||
sass-embedded (1.77.8)
|
||||
google-protobuf (~> 4.26)
|
||||
rake (>= 13)
|
||||
sass-embedded (1.77.8-aarch64-linux-android)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-aarch64-linux-gnu)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-aarch64-linux-musl)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-aarch64-mingw-ucrt)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-arm-linux-androideabi)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-arm-linux-gnueabihf)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-arm-linux-musleabihf)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-arm64-darwin)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-riscv64-linux-android)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-riscv64-linux-gnu)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-riscv64-linux-musl)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86-cygwin)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86-linux-android)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86-linux-gnu)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86-linux-musl)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86-mingw-ucrt)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86_64-cygwin)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86_64-darwin)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86_64-linux-android)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86_64-linux-gnu)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.77.8-x86_64-linux-musl)
|
||||
google-protobuf (~> 4.26)
|
||||
strscan (3.1.0)
|
||||
terminal-table (3.0.2)
|
||||
unicode-display_width (>= 1.1.1, < 3)
|
||||
unicode-display_width (2.5.0)
|
||||
webrick (1.8.1)
|
||||
|
||||
PLATFORMS
|
||||
aarch64-linux
|
||||
aarch64-linux-android
|
||||
aarch64-linux-gnu
|
||||
aarch64-linux-musl
|
||||
aarch64-mingw-ucrt
|
||||
arm-linux-androideabi
|
||||
arm-linux-gnu
|
||||
arm-linux-gnueabihf
|
||||
arm-linux-musl
|
||||
arm-linux-musleabihf
|
||||
arm64-darwin
|
||||
riscv64-linux-android
|
||||
riscv64-linux-gnu
|
||||
riscv64-linux-musl
|
||||
ruby
|
||||
x86-cygwin
|
||||
x86-linux
|
||||
x86-linux-android
|
||||
x86-linux-gnu
|
||||
x86-linux-musl
|
||||
x86-mingw-ucrt
|
||||
x86_64-cygwin
|
||||
x86_64-darwin
|
||||
x86_64-linux-android
|
||||
x86_64-linux-gnu
|
||||
x86_64-linux-musl
|
||||
|
||||
DEPENDENCIES
|
||||
http_parser.rb (~> 0.6.0)
|
||||
jekyll (~> 4.3.3)
|
||||
jekyll-feed (~> 0.12)
|
||||
just-the-docs
|
||||
minima (~> 2.5)
|
||||
tzinfo (>= 1, < 3)
|
||||
tzinfo-data
|
||||
wdm (~> 0.1.1)
|
||||
|
||||
BUNDLED WITH
|
||||
2.5.16
|
36
_config.yml
Normal file
36
_config.yml
Normal file
|
@ -0,0 +1,36 @@
|
|||
# Welcome to Jekyll!
|
||||
#
|
||||
# This config file is meant for settings that affect your whole blog, values
|
||||
# which you are expected to set up once and rarely edit after that. If you find
|
||||
# yourself editing this file very often, consider using Jekyll's data files
|
||||
# feature for the data you need to update frequently.
|
||||
#
|
||||
# For technical reasons, this file is *NOT* reloaded automatically when you use
|
||||
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
|
||||
#
|
||||
# If you need help with YAML syntax, here are some quick references for you:
|
||||
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
|
||||
# https://learnxinyminutes.com/docs/yaml/
|
||||
#
|
||||
# Site settings
|
||||
# These are used to personalize your new site. If you look in the HTML files,
|
||||
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
|
||||
# You can create any custom variable you would like, and they will be accessible
|
||||
# in the templates via {{ site.myvariable }}.
|
||||
|
||||
title: Monero Docs
|
||||
# email: docs@getmonero.org
|
||||
description: >- # this means to ignore newlines until "baseurl:"
|
||||
Official Monero Documentation
|
||||
baseurl: "" # the subpath of your site, e.g. /blog
|
||||
url: "https://docs.getmonero.org" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
twitter_username: monero
|
||||
github_username: monero-project
|
||||
|
||||
# Build settings
|
||||
theme: just-the-docs
|
||||
|
||||
# just-the-docs settings
|
||||
favicon_ico: "/assets/favicon-32x32.png"
|
||||
search_enabled: true
|
||||
show_sidebar: true
|
7
about.markdown
Normal file
7
about.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: About
|
||||
permalink: /about/
|
||||
---
|
||||
|
||||
This site includes documentation files of everything about Monero protocol. Source code is available in [GitHub](https://github.com/monero-project/monero-docs)
|
BIN
assets/favicon-32x32.png
Normal file
BIN
assets/favicon-32x32.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 975 B |
12
index.markdown
Normal file
12
index.markdown
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
layout: home
|
||||
---
|
||||
|
||||
Welcome to the official documentation of Monero protocol. You can see the table of contents below.
|
||||
|
||||
<br>
|
||||
|
||||
# Table Of Contents
|
||||
---
|
||||
|
||||
TODO
|
Loading…
Reference in a new issue