try manubot
1.0.0
Este repositório contém um manuscrito demo, destinado a um playground para que todos pratiquem usando Manubot.
Para editar o manuscrito, faça alterações nos arquivos no diretório content . Você pode editar arquivos com a interface da Web do Github usando o ícone lápis, conforme mostrado no vídeo de início. Como alternativa, se você tiver experiência com o Git e o Github, poderá gastar este repositório e fazer uma solicitação de tração tradicional.
Manubot é um sistema para escrever manuscritos acadêmicos via Github. Manubot automatiza citações e referências, versões manuscritos usando o GIT e permite a escrita colaborativa via Github. Um manuscrito de visão geral apresenta os benefícios da escrita colaborativa com o Manubot e seus recursos exclusivos. O repositório de porta -enxergamentos é um modelo de propósito geral para criar novas instâncias de Manubot, conforme detalhado em SETUP.md . Consulte USAGE.md para documentação como escrever um manuscrito.
Abra um problema para perguntas relacionadas ao uso do Manubot, relatórios de bugs ou consultas gerais.
Os diretórios são os seguintes:
content contém a fonte do manuscrito, que inclui arquivos de marcação, bem como entradas para citações e referências. Consulte USAGE.md para obter mais informações.output contém as saídas (arquivos gerados) do Manubot, incluindo os manuscritos resultantes. Você não deve editar esses arquivos manualmente, porque eles serão substituídos.webpage é um diretório destinado a ser renderizado como uma página estática para visualizar o manuscrito HTML.build contém comandos e ferramentas para criar o manuscrito.ci contém arquivos necessários para a implantação por meio da integração contínua. A maneira mais fácil de executar o Manubot é usar a integração contínua para reconstruir o manuscrito quando o conteúdo mudar. Se você deseja construir um manuscrito de Manubot localmente, instale o ambiente do CONDA, conforme descrito no build . Em seguida, você pode criar o manuscrito nos sistemas POSIX executando os seguintes comandos a partir deste diretório raiz.
# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot
# Build the manuscript, saving outputs to the output directory
bash build/build.sh
# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.
# Configure the webpage directory
manubot webpage
# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server Às vezes, é útil monitorar o diretório de conteúdo e reconstruir automaticamente o manuscrito quando uma alteração é detectada. O comando a seguir, enquanto estiver em execução, acionará o comando build.sh Script e manubot webpage após as mudanças de conteúdo:
bash build/autobuild.shSempre que uma solicitação de tração for aberta, o CI (integração contínua) testará se as alterações quebram o processo de construção para gerar um manuscrito formatado. O processo de construção tem como objetivo detectar erros comuns, como citações inválidas. Se a compilação da sua solicitação de tração falhar, consulte os logs do CI para a causa da falha e revise sua solicitação de tração de acordo.
Quando ocorre um compromisso com a ramificação main (por exemplo, quando uma solicitação de tração é mesclada), o CI constrói o manuscrito e grava os resultados nas gh-pages e nas ramificações output . A filial de gh-pages usa páginas do GitHub para hospedar os seguintes URLs:
Para detalhes de configuração de integração contínua, consulte .github/workflows/manubot.yaml .
Exceto quando observado o contrário, a totalidade deste repositório é licenciada sob uma licença CC por 4.0 ( LICENSE.md ), que permite reutilizar com atribuição. Atribua ligando-se a https://github.com/manubot/try-manubot.
Como o CC por não é ideal para código e dados, certos componentes do repositório também são lançados sob a dedicação do domínio público CC0 1.0 ( LICENSE-CC0.md ). Todos os arquivos combinados com os padrões globais a seguir são licenciados duplos em CC por 4.0 e CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreTodos os outros arquivos estão disponíveis apenas no CC por 4.0, incluindo:
*.md*.html*.pdf*.docxPor favor, abra um problema para qualquer pergunta relacionada ao licenciamento.
