aviso

Este tutorial é uma contribuição da comunidade e não é suportado pela equipe Nullcore. Serve apenas como uma demonstração sobre como personalizar o Nullcore para o seu caso de uso específico. Quer contribuir? Confira o tutorial contribuinte.

Tutoriais contribuintes

Agradecemos o seu interesse em contribuir com tutoriais para a documentação aberta da WebUI. Siga as etapas abaixo para configurar seu ambiente e enviar seu tutorial.

Passos

Bifurcar onullcore/docsRepositório do GitHub
- Navegue até oNullcore Docs Repositoryno github.
- Clique noGarfoBotão no canto superior direito para criar uma cópia na sua conta do GitHub.
Ativar ações do GitHub
- Em seu repositório bifurcado, navegue para oAçõesguia.
- Se solicitado, ative as ações do GitHub seguindo as instruções na tela.
Ativar páginas do github
- Vá paraConfiguraçõesPáginasem seu repositório bifurcado.
- SobFonte, selecione a filial que você deseja implantar (por exemplo,,main) e a pasta (por exemplo,,/docs
- CliqueSalvarPara ativar as páginas do GitHub.
Configurar variáveis de ambiente do GitHub
- Em seu repositório bifurcado, vá paraConfiguraçõesSegredos e variáveisAçõesVariáveis
- Adicione as seguintes variáveis de ambiente:
  - BASE_URLdefinido como/docs(ou seu URL base escolhido para o garfo).
  - SITE_URLdefinido comohttps://<your-github-username>.github.io/

📝 Atualizando o fluxo de trabalho do GitHub Pages e o arquivo de configuração

Se você precisar ajustar as configurações de implantação para se ajustar à sua configuração personalizada, aqui está o que fazer:

um.Atualizar.github/workflows/gh-pages.yml

Adicionar variáveis de ambiente paraBASE_URLeSITE_URLpara a etapa de construção, se necessário:

   nomeConstruir
    Env
      Base_url{{vars.base_url
      Site_url{{vars.site_url
    correrNPM Run Build

b.Modificardocusaurus.config.tsPara usar variáveis de ambiente

Atualizardocusaurus.config.tsPara usar essas variáveis de ambiente, com valores padrão para implantação local ou direta:

constConfigConfig {
título "Nullcore", Assim,
slogan "Webui no estilo ChatGPT para LLMS (anteriormente Ollama Webui)", Assim,
favicon "Images/favicon.png", Assim,
urlprocessoEnvSite_url  "https://doc.nullcore.com.br", Assim,
BaseurlprocessoEnvBase_url  , Assim,
  

Essa configuração garante comportamento de implantação consistente para garfos e configurações personalizadas.

Execute ogh-pagesFluxo de trabalho do GitHub
- NoAçõesguia, localize ogh-pagesfluxo de trabalho.
- Acionar o fluxo de trabalho manualmente, se necessário, ou pode ser executado automaticamente com base na sua configuração.
Navegue até a sua cópia bifurcada
- Visitahttps://<your-github-username>.github.io/<BASE_URL>Para ver sua documentação bifurcada.
Rascunhe suas alterações
- No seu repositório bifurcado, navegue até o diretório apropriado (por exemplo,,docs/tutorial/
- Crie um novo arquivo de marcação para o seu tutorial ou edite os existentes.
- Verifique se o seu tutorial inclui o banner de aviso não suportado.
Envie um pedido de tração
- Quando o seu tutorial estiver pronto, cometre suas alterações no seu repositório bifurcado.
- Navegue até o originalopen-webui/docsrepositório.
- CliqueNova solicitação de puxãoe selecione seu garfo e ramificação como fonte.
- Forneça um título descritivo e descrição para o seu PR.
- Envie a solicitação de tração para revisão.

Importante

Os tutoriais com a comunidade devem incluir o seguinte:

:::aviso
Este tutorial é uma contribuição da comunidade e não é suportado pela equipe Nullcore. Serve apenas como uma demonstração sobre como personalizar o Nullcore para o seu caso de uso específico. Quer contribuir? Confira o tutorial contribuinte.

Como testar docusaurus localmente

Você pode testar seu site docusaurus localmente com os seguintes comandos:

NPM Instale # Instale dependências
NPM Run Build # Construa o site para produção

Isso o ajudará a capturar quaisquer problemas antes de implantar