Skip to content

Commit fe8d38f

Browse files
committed
Docs: Trimming README.md to send to Raneto Docs
1 parent dd2ae78 commit fe8d38f

20 files changed

+165
-100
lines changed

README.md

Lines changed: 13 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -3,91 +3,17 @@ Raneto [![Node.js CI](https://github.com/ryanlelek/Raneto/actions/workflows/node
33

44
[![Raneto Logo](https://raw.githubusercontent.com/ryanlelek/Raneto/main/logo/logo_readme.png)](https://raneto.com/)
55

6-
[Raneto](https://raneto.com) is a free, open, simple Markdown powered knowledge base for Node.js.
6+
[Raneto](https://raneto.com) is a free, open, simple Markdown-powered knowledge base for Node.js.
77
[Find out more →](https://docs.raneto.com/what-is-raneto)
8-
9-
Important Updates
10-
-----------------
11-
12-
- **Please ensure you're on Raneto v0.17.1 for the latest security fixes**
13-
- Join the [Roadmap Discussion](https://github.com/ryanlelek/Raneto/issues/374)
14-
15-
Demo and Documentation
16-
----------------------
17-
18-
Visit [https://docs.raneto.com](https://docs.raneto.com) to see a demo.
19-
20-
Quickstart
21-
----------
22-
23-
Visit the [Example Repo](https://github.com/raneto/example)
24-
See the [installation guide](https://docs.raneto.com/install/installing-raneto) for more information.
25-
26-
Docker / Containers
27-
-------------------
28-
Official Raneto container images on [Docker Hub](https://hub.docker.com/r/raneto/raneto/tags)
29-
30-
Run the default container, and access on [localhost:3000](http://localhost:3000)
31-
`docker run --rm -it --publish 3000:3000 raneto/raneto:latest`
32-
33-
Same as above, but provide your own content and configuration
34-
```
35-
docker run --rm -it --publish 3000:3000 \
36-
--volume \
37-
--volume \
38-
raneto/raneto:latest
39-
```
40-
41-
Want to poke around the files in the container? Get a shell:
42-
`docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh`
43-
44-
Security
45-
--------
46-
Make sure you edit the default username and password in your `config.js` file.
47-
```
48-
##### WARNING #####
49-
// You MUST change the username and password for security
50-
// Do NOT use "admin" as a username as it's easily guessed.
51-
// You are encouraged to use tools to generate a password
52-
// Preferably, use a local password manager
53-
// If you absolutely must use an online tool, here are some suggestions
54-
// https://bitwarden.com/password-generator/
55-
// https://www.grc.com/passwords.htm
56-
```
57-
58-
Markdown Reference
59-
------------------
60-
If you want to embed links and images, you'll need to use the Markdown syntax.
61-
[See this Markdown Guide](https://www.markdownguide.org/cheat-sheet)
62-
63-
Links
64-
-----
65-
66-
- [Configuration](https://docs.raneto.com/usage/configuration)
67-
- [Production Notes](https://docs.raneto.com/install/production-notes)
68-
- [Deploying to Heroku](https://docs.raneto.com/tutorials/deploying-raneto-to-heroku)
69-
- [Contributing](https://github.com/ryanlelek/Raneto/blob/main/CONTRIBUTE.md)
70-
71-
Showcase
72-
--------
73-
74-
**Are you using Raneto in the wild?**
75-
We'd love to see it. Please add it to this list:
76-
* [Raneto Docs](https://docs.raneto.com)
77-
78-
79-
Related Projects
80-
----------------
81-
82-
- [Default Theme](https://github.com/raneto/theme-default)
83-
- [Deploy Raneto to your servers with Ansible](https://github.com/ryanlelek/raneto-devops) by @ryanlelek
84-
- [Run Raneto in a Vagrant container](https://github.com/draptik/vagrant-raneto) by @draptik
85-
- [Deploy Raneto using Docker container](https://github.com/appsecco/raneto-docker) by @madhuakula
86-
87-
Credits
88-
-------
89-
90-
- Raneto was created by [Gilbert Pellegrom](https://gilbitron.me)
91-
- Maintained by [Ryan Lelek](https://www.ryanlelek.com) from [AnsibleTutorials.com](https://www.ansibletutorials.com)
92-
- Logo by [@mmamrila](https://github.com/mmamrila)
93-
- Released under the [MIT license](https://github.com/ryanlelek/Raneto/blob/main/LICENSE)
8+
[Live Demo →](https://docs.raneto.com/)
9+
[Documentation →](https://docs.raneto.com/)
10+
11+
Top Features
12+
------------
13+
- All content is file-based
14+
- Markdown editor in the browser
15+
- Login system for edit protection
16+
- Simple and Lightweight
17+
18+
# Mailing List
19+
[Click here to join the mailing list](https://23afbd9f.sibforms.com/serve/MUIFAG1rmxtMH-Y_r96h_E7js7A7nUKcvP1fTNlIvKTMIzh7wD3u9SVbCiBc-Wo9TkSBADb2e3PEvAHWuXPMyUe_dEcdJsUihGQwDBX79nvS9bm3JYqyWOPjxacnexONo5yxNgHtnQKKG3JYtPS1LL1oejZ0rTchHzphtZuEbUJ3Hg6CimV69nbqhGKoNj-sPNhpvjSqgSIv3Zu0) for project news and important security alerts!

content/pages/community/credits.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Credits
2+
-------
3+
4+
- Raneto was created by [Gilbert Pellegrom](https://gilbitron.me)
5+
- Maintained by [Ryan Lelek](https://www.ryanlelek.com) from [AnsibleTutorials.com](https://www.ansibletutorials.com)
6+
- Logo by [@mmamrila](https://github.com/mmamrila)
7+
- Released under the [MIT license](https://github.com/ryanlelek/Raneto/blob/main/LICENSE)
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
Title: Related Projects
3+
Sort: 9
4+
---
5+
6+
This list contains additional projects that will help you deploy and run Raneto.
7+
8+
# Themes
9+
- [Default Theme](https://github.com/raneto/theme-default)
10+
11+
# Deployment
12+
- [Deploy Raneto to your servers with Ansible](https://github.com/ryanlelek/raneto-devops) by [@ryanlelek](https://github.com/ryanlelek)
13+
- [Run Raneto in a Vagrant container](https://github.com/draptik/vagrant-raneto) by [@draptik](https://github.com/draptik)
14+
- [Deploy Raneto using Docker container](https://github.com/appsecco/raneto-docker) by [@madhuakula](https://github.com/madhuakula)

content/pages/community/roadmap.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
Title: Roadmap
3+
Sort: 9
4+
---
5+
6+
# Raneto Roadmap
7+
- Join the [Roadmap Discussion](https://github.com/ryanlelek/Raneto/issues/374)

content/pages/showcase.md renamed to content/pages/community/showcase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ Title: Showcase
33
Sort: 8
44
---
55

6-
Using Raneto in the wild? We'd love to see it.
6+
**Are you using Raneto in the wild?**
7+
We'd love to see it.
78
Add your site to the [Raneto Showcase](https://github.com/ryanlelek/Raneto/wiki/Raneto-Showcase).

content/pages/community/sort

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
6
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
Title: Containers
3+
Sort: 8
4+
---
5+
6+
# Containers (Docker)
7+
8+
Official Raneto container images on [Docker Hub](https://hub.docker.com/r/raneto/raneto/tags)
9+
10+
Run the default container, and access on [localhost:3000](http://localhost:3000)
11+
`docker run --rm -it --publish 3000:3000 raneto/raneto:latest`
12+
13+
Same as above, but provide your own content and configuration
14+
```
15+
docker run --rm -it --publish 3000:3000 \
16+
--volume \
17+
--volume \
18+
raneto/raneto:latest
19+
```
20+
21+
Want to poke around the files in the container? Get a shell:
22+
`docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh`

content/pages/deployment/security.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
Title: Default Password
3+
Sort: 8
4+
---
5+
6+
# Default Password
7+
Make sure you edit the default username and password in your `config.js` file.
8+
```
9+
##### WARNING #####
10+
// You MUST change the username and password for security
11+
// Do NOT use "admin" as a username as it's easily guessed.
12+
// You are encouraged to use tools to generate a password
13+
// Preferably, use a local password manager
14+
// If you absolutely must use an online tool, here are some suggestions
15+
// https://bitwarden.com/password-generator/
16+
// https://www.grc.com/passwords.htm
17+
```
File renamed without changes.

content/pages/getting-started.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
Title: Getting Started
3+
Sort: 2
4+
ShowOnHome: true
5+
ShowOnMenu: true
6+
---
7+
8+
# Markdown Reference
9+
If you want to embed links and images, you'll need to use the Markdown syntax.
10+
[See this Markdown Guide](https://www.markdownguide.org/cheat-sheet)
11+
12+
# Essentials
13+
Visit the [Example Repo](https://github.com/raneto/example)
14+
See the [installation guide](https://docs.raneto.com/install/installing-raneto) for more information.
15+
16+
# Links
17+
- [Configuration](https://docs.raneto.com/usage/configuration)
18+
- [Production Notes](https://docs.raneto.com/install/production-notes)
19+
- [Deploying to Heroku](https://docs.raneto.com/tutorials/deploying-raneto-to-heroku)
20+
- [Contributing](https://github.com/ryanlelek/Raneto/blob/main/CONTRIBUTE.md)

content/pages/news.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
Title: News
3+
Sort: 3
4+
ShowOnHome: true
5+
ShowOnMenu: true
6+
---
7+
8+
# Raneto News
9+
10+
## April 30th 2024
11+
### Changes
12+
- v0.18.x is bringing big updates to modernize Raneto
13+
- Separated theme + Raneto for easier customization
14+
- Dependency upgrades across the board
15+
### Upcoming
16+
- Slimming down the project. After 10+ years, some packages are either no longer needed or not maintained
17+
- Official support for containers (Docker, Podman)
18+
- Complete revisit of the documentation

content/pages/related-projects.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

content/pages/tutorials/sort

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5
1+
3

content/pages/updates/sort

Lines changed: 0 additions & 1 deletion
This file was deleted.

content/pages/usage/highlight-code.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
Title: Highlight Node.js Code Title
3+
Sort: 2
4+
---
5+
6+
# Introduction
7+
You can highlight code by using the HTML pattern in your Markdown like this:
8+
```
9+
<pre><code>
10+
Code goes here...
11+
</code></pre>
12+
```
13+
You language should be detected automatically but it's better to be explicit.
14+
```
15+
<pre><code class="language-javascript">
16+
Code goes here...
17+
</code></pre>
18+
```
19+
The list of languages is on this [highlight.js documentation page](https://highlightjs.readthedocs.io/en/latest/supported-languages.html)
20+
21+
## Node.js Code
22+
<pre><code class="language-javascript">let value = 'variable';
23+
const OK = true;
24+
function fn() {
25+
console.log("Works");
26+
}
27+
</code></pre>
28+
29+
## SQL Code
30+
<pre><code class="language-sql">CREATE TABLE "topic" (
31+
"id" integer NOT NULL PRIMARY KEY,
32+
"forum_id" integer NOT NULL,
33+
"subject" varchar(255) NOT NULL
34+
);
35+
ALTER TABLE "topic"
36+
ADD CONSTRAINT forum_id FOREIGN KEY ("forum_id")
37+
REFERENCES "forum" ("id");
38+
39+
-- Initials
40+
insert into "topic" ("forum_id", "subject")
41+
values (2, 'D''artagnian');
42+
</code></pre>

content/pages/what-is-raneto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Title: What is Raneto?
33
Sort: 1
44
ShowOnHome: true
5-
ShowOnMenu: false
5+
ShowOnMenu: true
66
---
77

88
Raneto is a Knowledgebase platform for [Node.js](https://nodejs.org/) that uses static

0 commit comments

Comments
 (0)