Skip to content

Commit

Permalink
Docs: Trimming README.md to send to Raneto Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanlelek committed Apr 30, 2024
1 parent dd2ae78 commit fe8d38f
Show file tree
Hide file tree
Showing 20 changed files with 165 additions and 100 deletions.
100 changes: 13 additions & 87 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,91 +3,17 @@ Raneto [![Node.js CI](https://github.com/ryanlelek/Raneto/actions/workflows/node

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

[Raneto](https://raneto.com) is a free, open, simple Markdown powered knowledge base for Node.js.
[Raneto](https://raneto.com) is a free, open, simple Markdown-powered knowledge base for Node.js.
[Find out more →](https://docs.raneto.com/what-is-raneto)

Important Updates
-----------------

- **Please ensure you're on Raneto v0.17.1 for the latest security fixes**
- Join the [Roadmap Discussion](https://github.com/ryanlelek/Raneto/issues/374)

Demo and Documentation
----------------------

Visit [https://docs.raneto.com](https://docs.raneto.com) to see a demo.

Quickstart
----------

Visit the [Example Repo](https://github.com/raneto/example)
See the [installation guide](https://docs.raneto.com/install/installing-raneto) for more information.

Docker / Containers
-------------------
Official Raneto container images on [Docker Hub](https://hub.docker.com/r/raneto/raneto/tags)

Run the default container, and access on [localhost:3000](http://localhost:3000)
`docker run --rm -it --publish 3000:3000 raneto/raneto:latest`

Same as above, but provide your own content and configuration
```
docker run --rm -it --publish 3000:3000 \
--volume \
--volume \
raneto/raneto:latest
```

Want to poke around the files in the container? Get a shell:
`docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh`

Security
--------
Make sure you edit the default username and password in your `config.js` file.
```
##### WARNING #####
// You MUST change the username and password for security
// Do NOT use "admin" as a username as it's easily guessed.
// You are encouraged to use tools to generate a password
// Preferably, use a local password manager
// If you absolutely must use an online tool, here are some suggestions
// https://bitwarden.com/password-generator/
// https://www.grc.com/passwords.htm
```

Markdown Reference
------------------
If you want to embed links and images, you'll need to use the Markdown syntax.
[See this Markdown Guide](https://www.markdownguide.org/cheat-sheet)

Links
-----

- [Configuration](https://docs.raneto.com/usage/configuration)
- [Production Notes](https://docs.raneto.com/install/production-notes)
- [Deploying to Heroku](https://docs.raneto.com/tutorials/deploying-raneto-to-heroku)
- [Contributing](https://github.com/ryanlelek/Raneto/blob/main/CONTRIBUTE.md)

Showcase
--------

**Are you using Raneto in the wild?**
We'd love to see it. Please add it to this list:
* [Raneto Docs](https://docs.raneto.com)


Related Projects
----------------

- [Default Theme](https://github.com/raneto/theme-default)
- [Deploy Raneto to your servers with Ansible](https://github.com/ryanlelek/raneto-devops) by @ryanlelek
- [Run Raneto in a Vagrant container](https://github.com/draptik/vagrant-raneto) by @draptik
- [Deploy Raneto using Docker container](https://github.com/appsecco/raneto-docker) by @madhuakula

Credits
-------

- Raneto was created by [Gilbert Pellegrom](https://gilbitron.me)
- Maintained by [Ryan Lelek](https://www.ryanlelek.com) from [AnsibleTutorials.com](https://www.ansibletutorials.com)
- Logo by [@mmamrila](https://github.com/mmamrila)
- Released under the [MIT license](https://github.com/ryanlelek/Raneto/blob/main/LICENSE)
[Live Demo →](https://docs.raneto.com/)
[Documentation →](https://docs.raneto.com/)

Top Features
------------
- All content is file-based
- Markdown editor in the browser
- Login system for edit protection
- Simple and Lightweight

# Mailing List
[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!
File renamed without changes.
7 changes: 7 additions & 0 deletions content/pages/community/credits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Credits
-------

- Raneto was created by [Gilbert Pellegrom](https://gilbitron.me)
- Maintained by [Ryan Lelek](https://www.ryanlelek.com) from [AnsibleTutorials.com](https://www.ansibletutorials.com)
- Logo by [@mmamrila](https://github.com/mmamrila)
- Released under the [MIT license](https://github.com/ryanlelek/Raneto/blob/main/LICENSE)
14 changes: 14 additions & 0 deletions content/pages/community/related-projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
Title: Related Projects
Sort: 9
---

This list contains additional projects that will help you deploy and run Raneto.

# Themes
- [Default Theme](https://github.com/raneto/theme-default)

# Deployment
- [Deploy Raneto to your servers with Ansible](https://github.com/ryanlelek/raneto-devops) by [@ryanlelek](https://github.com/ryanlelek)
- [Run Raneto in a Vagrant container](https://github.com/draptik/vagrant-raneto) by [@draptik](https://github.com/draptik)
- [Deploy Raneto using Docker container](https://github.com/appsecco/raneto-docker) by [@madhuakula](https://github.com/madhuakula)
7 changes: 7 additions & 0 deletions content/pages/community/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
Title: Roadmap
Sort: 9
---

# Raneto Roadmap
- Join the [Roadmap Discussion](https://github.com/ryanlelek/Raneto/issues/374)
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ Title: Showcase
Sort: 8
---

Using Raneto in the wild? We'd love to see it.
**Are you using Raneto in the wild?**
We'd love to see it.
Add your site to the [Raneto Showcase](https://github.com/ryanlelek/Raneto/wiki/Raneto-Showcase).
1 change: 1 addition & 0 deletions content/pages/community/sort
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6
22 changes: 22 additions & 0 deletions content/pages/deployment/containers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
Title: Containers
Sort: 8
---

# Containers (Docker)

Official Raneto container images on [Docker Hub](https://hub.docker.com/r/raneto/raneto/tags)

Run the default container, and access on [localhost:3000](http://localhost:3000)
`docker run --rm -it --publish 3000:3000 raneto/raneto:latest`

Same as above, but provide your own content and configuration
```
docker run --rm -it --publish 3000:3000 \
--volume \
--volume \
raneto/raneto:latest
```

Want to poke around the files in the container? Get a shell:
`docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh`
File renamed without changes.
17 changes: 17 additions & 0 deletions content/pages/deployment/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
Title: Default Password
Sort: 8
---

# Default Password
Make sure you edit the default username and password in your `config.js` file.
```
##### WARNING #####
// You MUST change the username and password for security
// Do NOT use "admin" as a username as it's easily guessed.
// You are encouraged to use tools to generate a password
// Preferably, use a local password manager
// If you absolutely must use an online tool, here are some suggestions
// https://bitwarden.com/password-generator/
// https://www.grc.com/passwords.htm
```
File renamed without changes.
File renamed without changes.
20 changes: 20 additions & 0 deletions content/pages/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
Title: Getting Started
Sort: 2
ShowOnHome: true
ShowOnMenu: true
---

# Markdown Reference
If you want to embed links and images, you'll need to use the Markdown syntax.
[See this Markdown Guide](https://www.markdownguide.org/cheat-sheet)

# Essentials
Visit the [Example Repo](https://github.com/raneto/example)
See the [installation guide](https://docs.raneto.com/install/installing-raneto) for more information.

# Links
- [Configuration](https://docs.raneto.com/usage/configuration)
- [Production Notes](https://docs.raneto.com/install/production-notes)
- [Deploying to Heroku](https://docs.raneto.com/tutorials/deploying-raneto-to-heroku)
- [Contributing](https://github.com/ryanlelek/Raneto/blob/main/CONTRIBUTE.md)
18 changes: 18 additions & 0 deletions content/pages/news.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
Title: News
Sort: 3
ShowOnHome: true
ShowOnMenu: true
---

# Raneto News

## April 30th 2024
### Changes
- v0.18.x is bringing big updates to modernize Raneto
- Separated theme + Raneto for easier customization
- Dependency upgrades across the board
### Upcoming
- Slimming down the project. After 10+ years, some packages are either no longer needed or not maintained
- Official support for containers (Docker, Podman)
- Complete revisit of the documentation
9 changes: 0 additions & 9 deletions content/pages/related-projects.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/pages/tutorials/sort
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5
3
1 change: 0 additions & 1 deletion content/pages/updates/sort

This file was deleted.

42 changes: 42 additions & 0 deletions content/pages/usage/highlight-code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
Title: Highlight Node.js Code Title
Sort: 2
---

# Introduction
You can highlight code by using the HTML pattern in your Markdown like this:
```
<pre><code>
Code goes here...
</code></pre>
```
You language should be detected automatically but it's better to be explicit.
```
<pre><code class="language-javascript">
Code goes here...
</code></pre>
```
The list of languages is on this [highlight.js documentation page](https://highlightjs.readthedocs.io/en/latest/supported-languages.html)

## Node.js Code
<pre><code class="language-javascript">let value = 'variable';
const OK = true;
function fn() {
console.log("Works");
}
</code></pre>

## SQL Code
<pre><code class="language-sql">CREATE TABLE "topic" (
"id" integer NOT NULL PRIMARY KEY,
"forum_id" integer NOT NULL,
"subject" varchar(255) NOT NULL
);
ALTER TABLE "topic"
ADD CONSTRAINT forum_id FOREIGN KEY ("forum_id")
REFERENCES "forum" ("id");

-- Initials
insert into "topic" ("forum_id", "subject")
values (2, 'D''artagnian');
</code></pre>
2 changes: 1 addition & 1 deletion content/pages/what-is-raneto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Title: What is Raneto?
Sort: 1
ShowOnHome: true
ShowOnMenu: false
ShowOnMenu: true
---

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

0 comments on commit fe8d38f

Please sign in to comment.