Raneto é uma base de conhecimento gratuita e de código aberto, construída sobre o Node.js, que é fácil de configurar e usar, além de ser fácil de administrar. Categorias e páginas são escritas em Markdown, o que facilita a edição. Se Markdown não é sua coisa, Raneto também permite que você use HTML.
Pré-requisitos
- Um VPS com o Ubuntu 17.10 instalado.
- Acesso SSH ao seu VPS.
- Conhecimento básico do terminal Linux.
Login
Primeiro, precisamos fazer login no nosso servidor usando o SSH. Para fazer isso, abra seu cliente SSH favorito.
ssh [email protected]_IP
Depois de inserir sua senha (você pode obtê-lo no painel do Site & Site), você será conectado ao seu VPS.
Instalando o Node.js e o PM2
O Raneto é executado no Node.js, um tempo de execução e estrutura de javascript. Neste tutorial, usaremos o Node.js v8 por causa de seu suporte de longo prazo. Inicie a instalação digitando o seguinte comando.
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
Depois que esse script terminar a execução, você poderá executar a instalação principal.
sudo apt-get install -y nodejs
Quando este instalador terminar, você terá uma cópia atualizada do Node.js instalado no seu VPS. Em seguida, instalaremos o PM2, um gerenciador de processos para o Node.js que facilita a execução do Raneto (e de muitos outros aplicativos Node.js).
npm install pm2 -g
Agora temos todos os softwares que precisamos para instalar o Raneto.
Instalando Raneto
Vamos usar o Git para clonar o repositório Raneto em nosso servidor.
git clone https://github.com/gilbitron/Raneto.git
Isto irá criar uma pasta chamada Raneto
. Digite a pasta.
cd Raneto
Instale o NPM.
npm install
Execute Gulp digitando o seguinte.
npm run gulp
Depois que o Gulp terminar, poderemos iniciar nosso aplicativo usando um dos dois comandos a seguir.
npm start
# or
npm example/server.js
Agora você poderá acessar sua nova instalação do Raneto navegando até SERVER_IP:3000
. O restante deste tutorial ensinará como configurar o Raneto, criar novas páginas, adicionar categorias, ajustar a classificação, adicionar uma página personalizada e editar o modelo.
Configuração adicional
Agora você tem uma instalação padrão do Raneto hospedada no seu VPS. Antes de começar a fazer qualquer outra coisa, sugiro que você faça algumas alterações na configuração e configuração padrão.
Vamos dar uma olhada config.default.js
, que está localizada na example
pasta. Este arquivo de configuração é bastante longo, mas por favor não fique sobrecarregado, como é fortemente comentado. Aqui estão as propriedades que você deve editar:
site_title
– Altere isso para o título do seu site.base_url
– Isso deve ser definido para o URL do seu site. Pode ser usado como uma variável ao editar páginas.support_email
– Altere isso para um email válido. Ele será exibido no rodapé do site.copyright
– Texto de rodapé.analytics
– Adicione um código de acompanhamento do Google Analytics aqui.allow_editing
– Você quer poder editar arquivos usando o editor da web?authentication_for_read
– Você quer que as pessoas façam login para visualizar o site?credentials
– Adicione usuários aqui se o login estiver ativado.locale
– Língua.datetime_format
– Formato da data e hora.home_meta
– Edite isso para alterar as informações meta da sua página inicial.table_of_content
– Raneto deve exibir um índice?
Usando o editor on-line
Raneto vem com uma interface on-line fácil de usar para gerenciar páginas, categorias e muito mais. Embora não permita que você faça tudo, certamente será útil se você precisar fazer uma edição rápida em qualquer lugar.
Você pode acessá-lo ativando a configuração config.default.js
(como mencionado acima) e depois visitando seu VPS e clicando no botão de login no canto superior direito. Digite seu nome de usuário e senha (você pode alterá-los config.default.js
) e clique em login. Basta clicar na página que você precisa editar, clicar na lista Actions
suspensa e escolher a ação que deseja concluir. Você pode adicionar páginas pressionando o +
botão ao lado do nome da categoria e pode criar categorias usando o campo de entrada no canto superior esquerdo.
Adicionando Páginas
Adicionar páginas é tão simples quanto criar um novo .md
documento Markdown ( ) na example/content
pasta.
Depois de criar um novo arquivo Markdown, é importante adicionar algumas informações básicas à parte superior do arquivo. Abra o arquivo no seu editor de texto favorito. Precisamos adicionar o seguinte ao topo do arquivo.
/*
Title: Enter your page title here, if none is added, the file-name will be used
Description: Enter your page's description here (for search engines and the site search feature)
ShowOnHome: true/false
*/
Se precisar, você também pode usar as seguintes variáveis em suas páginas:
%base_url%
– Isso permite que você mencione o URL do seu site.%image_url%
– Isso permite que você obtenha o URL base do diretório de imagens.
Adicionando Categorias
Você pode adicionar categorias à sua base de conhecimento com facilidade. Basta criar uma nova pasta no example/content
diretório e colocar as páginas que você deseja estar nessa categoria nessa pasta. Por exemplo, digamos que queríamos uma categoria chamada help
com páginas chamadas contact
, help-me
e awesome
. Os arquivos ficariam assim:
/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md
Você pode adicionar quantas subpastas quiser dentro de categorias.
Categorias também podem ter informações meta. Crie um arquivo chamado meta
na pasta de categorias. Os seguintes atributos são suportados (todos opcionais):
- Título – Substitui o título com base no nome da pasta.
- Classificar – Permite classificar a ordem das categorias, funciona da mesma maneira que as páginas de classificação.
- ShowOnHome – verdadeiro / falso.
Homepage personalizada
Se você quiser adicionar uma página personalizada, tudo o que você precisa fazer é adicionar um arquivo de marcação chamado index.md
à sua example/content
pasta.
Classificando Páginas
O Raneto classifica automaticamente as páginas em ordem alfabética, mas você pode aplicar uma classificação manual adicionando um Sort
item à meta da página. O valor de sort deve ser um inteiro, por exemplo:
Sort: 7
Esta página agora apareceria antes de páginas com um valor de classificação de 8 ou mais, mas depois de páginas com um valor de 6 ou menos.
Mudando o modelo
Se você estiver familiarizado com HTML ou CSS, poderá alterar facilmente a aparência da sua instalação do Raneto. Raneto usa Handlebars, uma linguagem de templates JavaScript, que modula a edição de HTML. Você pode encontrar os arquivos de tema na themes/default
pasta. Se você quiser mais informações sobre a edição de modelos Renato, visite a seção de ajuda deles . Quando terminar de editar o modelo, certifique-se de reiniciar o aplicativo.