Fluxo de trabalho de conteúdo usando o Github e o Markdown


Índice

Introdução: O problema
As quatro regras do fluxo de trabalho de conteúdo
Configurando suas ferramentas
Preparando-se para escrever
Escrevendo
Comprometendo (salvando) seu trabalho
Publicação
Reaproveitamento
Recursos

TL; DR Nós publicamos conteúdo digital. Nós escrevemos e criamos para a internet e telas. Mas nosso fluxo de trabalho de conteúdo remonta aos dias da publicação de desktop. Este post sugere uma maneira melhor de usar o Github e o Markdown. Ele se distancia de processadores e pastas de texto, ajudando você a criar conteúdo pronto para ser reutilizado. Ele usa ferramentas prontamente disponíveis que não infestam seu trabalho nem o colocam em formatos proprietários. Leia sobre um walkthru passo-a-passo. Com algumas paradas para reclamar e delirar.

Alguns anos atrás eu medi como eu gasto tempo ao escrever. Eu queria ver onde / se eu pudesse ajustar meu fluxo de trabalho de conteúdo. O resultado foi tão deprimente que eu usei o mesmo par de meias de ciclismo por uma semana:

Demoro cerca de 90 minutos para escrever uma postagem no blog de 750 palavras. Nesse tempo, eu gasto:

  • 45 minutos escrevendo
  • 15 minutos de edição
  • 30 minutos fazendo… o que exatamente?

Esperar. O que? Isso não pode estar certo. Eu gasto um terço do meu tempo em um projeto de escrita não escrevendo.

O que. O. Real. Fucklebucket.*

Então eu chequei minhas anotações.

33% do tempo de escrita é sugado de mim pela estupidez que desperdiçou tempo:

  • Flailing ao redor, tentando limpar um problema de formatação em um post no blog
  • Solução de problemas de software
  • Desenterrando a segunda versão da minha introdução, que eu pensar Eu gostei mais do que do quinto e sexto, mas eu sinceramente não me lembro, porque eu normalmente apenas deleto e escrevo mais coisas
  • Tentando descobrir como diabos eu crio uma citação inteligente
  • Reformatar um documento inteiro do Word porque o editor o quer no formato do Google Docs
  • Recapturando imagens porque elas estão todas incorporadas no documento e parecem

Todos esses exemplos se dividem em dois grupos: Formatação e gerenciamento de versão. Ambos são nossos trabalhos. Mesmo que tenhamos nossa própria equipe editorial e de design

HAHAHAHA EU DISSO APENAS DISSE QUE PORQUE YEAH CERTO TENHO 3 PESSOAS NO MEU BECK E CHAMADA APENAS PARA CERTIFIQUE-SE QUE MEU MATERIAL OLHA BOM HAHAHAHAHAAAAAAA tosse sniff

nós somos responsáveis ​​pela primeira passagem. A formatação e o gerenciamento de versões fazem parte do nosso trabalho.

E nós chupamos eles.

Nos preocupamos em lançar o próximo post do blog por cima do muro, em vez de criar conteúdo versátil que possamos publicar em qualquer lugar e reutilizá-lo a qualquer momento.

Nós temos problemas

Eu penso primeiro em decoração, estrutura em segundo.

Nos preocupamos em lançar o próximo post do blog por cima do muro, em vez de criar conteúdo versátil que possamos publicar em qualquer lugar e reutilizá-lo a qualquer momento.

Nós economizamos cinco minutos agora e nos custamos horas depois.

Nós gastamos nosso tempo escrevendo, editando e publicando. Mas ignoramos as coisas que movem o conteúdo entre essas etapas: Fluxo de trabalho. Portanto, nosso fluxo de trabalho está repleto de buracos e vidro quebrado. Ainda temos que passar da escrita para a edição para publicação. Mas, em vez de ajudar, o fluxo de trabalho nos atrasa.

Um fluxo de trabalho desatualizado para ferramentas desatualizadas

Estamos trabalhando na internet, mas usamos ferramentas criadas para editoração eletrônica nos anos 80. Sim, até mesmo seus jovens de rosto fresco, com costas saudáveis ​​e sem pêlos de orelha, estão usando o software equivalente de antiguidades.

Estou falando de processadores de texto. Os processadores de texto não foram projetados para escrevendo. Eles foram projetados para digitando e decorando. O Word, o Google Docs e seus parentes demônios foram criados para levar o tipo ousada Comic Sans às massas. Eles são não projetado para ajudar os escritores a criar, gerenciar e publicar conteúdo estruturado.

Eu também estou falando sobre armazenamento. Arquivos salvos em pastas – online ou offline – são uma metáfora para papel e arquivos. Eles são tão úteis quanto o telefone com fio que agora uso como batente de porta. Eles foram criados para que uma pessoa (talvez duas) pudesse trabalhar em um conteúdo por vez.

Claro, existem ferramentas que prometem atualizar tudo isso, agilizar o fluxo de trabalho, etc. Todas elas se tornam versões inchadas e caras dos processadores de texto e metáforas de armazenamento datadas que eles tentam substituir. Buracos mais extravagantes. Mais quebrado vidro.

Então poof. Um terço do meu tempo passou porque estou gastando meu tempo no Dropbox e trabalhando no Microsoft Word e no Google Docs.

Precisamos de uma maneira melhor de fazer isso.

Encontre um caminho melhor

Isso é o que eu trabalhei: um fluxo de trabalho que cria conteúdo estruturado e reutilizável. Permite-me gerir versões em dispositivos e vários escritores. E funciona bem para posts de 750 palavras, bem como livros de capítulos.

Mais importante, permite-me passar mais tempo escrevendo.

Também há um bom benefício para tudo isso: sua escrita fica melhor na Web. Vamos enfrentá-lo: a maioria de nós escreve para a web. Estamos publicando posts do blog todos os dias. Use este fluxo de trabalho e sua escrita está pronta para a web (eu odeio essa frase, mas funciona aqui). Parece melhor, carrega mais rápido e obtém visão geeks HTML como eu acenando com aprovação.

Sinta-se à vontade para experimentar todas ou algumas delas.

Também fique à vontade para me encontrar no LinkedIn ou no Twitter: @portentint e https://www.linkedin.com/in/ianlurie/

As quatro regras do fluxo de trabalho de conteúdo

Primeiro, um fluxo de trabalho bem sucedido deve seguir estas quatro regras:

Estrutura> Formato e Design

Estrutura importa mais do que formato ou desenhar: O fato de você ter dito, um título de nível um é mais importante do que exatamente como aquele título de um nível parece, porque pode parecer diferente em várias plataformas.

Você pode despejar conteúdo bem estruturado em vários formatos diferentes, do Microsoft Word ao HTML. Você pode alterar facilmente o design de conteúdo bem estruturado usando CSS ou qualquer outro modelo, incluindo o Microsoft Word e o Google Docs.

Você também pode facilmente reutilizar conteúdo bem estruturado, adaptando-o da prosa à apresentação e ao roteiro.

Portanto, um bom fluxo de trabalho de conteúdo deve suportar a estrutura primeiro, o formato e o design em segundo.

Ferramentas proprietárias são armadilhas

Ferramentas – processadores de texto, por exemplo – nos prendem a formatos proprietários. Eles também nos prendem em dispositivos específicos.

Sim, posso abrir um arquivo do Google Doc ou Word no meu telefone. Sim, eu poderia editá-lo. Mas não vou, porque é horrível.

Preciso de um processo de plataforma cruzada que seja o mais independente possível de ferramentas.

Reaproveitamento é inevitável

Criadores de conteúdo inteligentes reutilizam seu trabalho.

  • E-books se tornam série de blogs
  • Postagens no blog se tornam decks de slides
  • Transcrições se tornam postagens de blog
  • Documentos do Word se tornam o Google Docs se tornando HTML

Eu vou redirecionar o conteúdo. Meu fluxo de trabalho tem que suportar isso.

Bons Escritores São Hoarders Ordenados

Eu sempre pareço apagar um arquivo antigo momentos antes de precisar dele. Ou eu esqueço porque fiz uma edição. Ou eu edito em círculos, terminando de volta onde eu comecei.

Precisamos manter tudo para cada projeto:

  • Todas as revisões e rascunhos
  • Todos os arquivos de imagem
  • Todos os outros arquivos de suporte
  • O histórico completo de alterações de todos os itens acima

E precisamos mantê-lo em um formato organizado.

Configurando suas ferramentas

Você só tem que fazer este trabalho uma vez. Se você nunca usou essas ferramentas, há uma curva de aprendizado que parece bem curta se você estiver usando um software para computador.

Ainda assim, é preciso ter um pouco de paciência para instalar coisas novas. Aproveite o tempo extra agora e você economizará horas depois.

Instalar ferramentas de redução de estoque

Primeiro, você vai trabalhar no Markdown. Eu já escrevi sobre o porquê, então não vou perder muitas palavras aqui. O Markdown é uma linguagem de marcação super simples, perfeita para escritores. Tudo o que você está lendo agora começou como Markdown.

Há também um ótimo tutorial aqui e uma tabela de sintaxe aqui.

Você pode escrever Markdown usando um editor de texto simples, depois pré-visualizá-lo e exportá-lo para outros formatos, como HTML.

Mas há alguns editores com foco no Markdown que facilitam isso. Eles ainda usam texto simples – sem formatação proprietária – mas achatam a curva de aprendizado. Meu favorito é o Typora.

Typora

O Typora é executado no OS X, Windows e Linux. Digite Markdown e o Typora fornece uma pré-visualização instantânea. Então, se eu digitar:

# Typora

Ele imediatamente transforma isso em um nível um "Typora".

Baixe aqui: typora.io.

Nota: Quando você instala o Typora, vá para Preferências ou Configurações (dependendo do sistema operacional). Encontre a guia / configurações de Markdown. Desmarque a opção "Smart Quotes":

Desativar as aspas inteligentes no Typora

O Typora é preenchido com todos os tipos de outros recursos, como combos-chave para adicionar links e definir cabeçalhos. Não deixe de explorá-lo.

Outras opções

Eu também gosto muito de:

  • Dillinger.io
  • iaWriter
  • Ulisses

E meu favorito de longa data, atom.io. O Atom é um editor de texto puro, por isso não é tão amigável, mas é rápido e fácil de personalizar. Se você quiser ficar mais nerd, essa é sua melhor escolha.

Você pode usar uma ferramenta de pré-visualização e exportação independente como a Marcada 2, ou automatizar modelos avançados e lotes com Pandoc (curva de aprendizado muito íngreme, muito poderosa). Mas, para 99% do seu trabalho, os recursos de exportação do Typora funcionarão bem.

Configurar o controle de versão com o Github

Fluxo de trabalho da regra de conteúdo Número quatro: precisamos ser colecionadores ordenados. Para fazer isso, use o Github.

Os desenvolvedores criaram para dar suporte aos desenvolvedores. Mas o que os desenvolvedores fazem? Eles digitam coisas em arquivos. Eles salvam os arquivos. Eles gerenciam versões desses arquivos enquanto muitos outros desenvolvedores editam e contribuem.

Então, essa ferramenta que eles construíram é perfeita para escritores também. E embora pareça assustador, não é tão difícil de aprender.

  1. Instale o Git no seu computador. Você pode obter o instalador do Windows aqui e o instalador do OS X aqui. Se você está no Linux, eu suponho que você sabe o que está fazendo.
  2. Vá para github.com
  3. Configurar uma conta
  4. Faça o download do cliente de desktop do Github

Você está pronto.

O Git permitirá que você acompanhe as alterações com muito mais detalhes do que o Microsoft Word e passe o seu trabalho em busca de revisões simultâneas ou contribuições de muitas outras pessoas.

Também está perto de à prova de balas, o que você realmente apreciará se já usou o acompanhamento de revisões no Word, no Google Docs e em outras ferramentas.

Um último gadget

Vá buscar o TextExpander. Sim, custa um pouco de dinheiro. Vale a pena.

Depois de instalá-lo, inscreva-se neste grupo de fragmentos:

Entidades HTML

É onde eu mantenho os atalhos que uso para criar citações inteligentes e coisas assim. Eles são úteis se você está com pressa ou não consegue lembrar a entidade HTML para uma cotação inteligente à direita (como eu).

O que você tem

Você está pronto para seguir todas as quatro regras do fluxo de trabalho de conteúdo:

  • Markdown e Typora ajudam você a criar estrutura
  • Você não está usando nenhum formato proprietário
  • O conteúdo resultante será facilmente redirecionado de um formato para outro
  • Graças ao Github, você será um colecionador ordenado

Espero que todo este processo não tenha demorado mais de quinze minutos. Se isso acontecer, peço desculpas. Por favor, jogue latas de bebida vazias em mim na próxima vez que você me ver. Os vazios. Não é como se eu tivesse roubado seu carro ou algo assim.

Preparando-se para escrever

Eu tenho muitos passos aqui, mas isso leva cerca de cinco minutos, comece a terminar:

Etapa 1: Crie sua pasta e arquivo de trabalho

Seu trabalho precisa de um lar. Crie um com antecedência. Estou escrevendo isso para me preparar para o Learn Inbound. Eu vou ter imagens e alguns arquivos de apoio.

Agora, crie seu arquivo de remarcação.

  1. Crie uma pasta onde seu trabalho vai viver. Estou escrevendo isso para me preparar para o Learn Inbound. Eu vou ter imagens e alguns arquivos de apoio. Eu crio pastas de acordo
  2. Abra o Typora
  3. Clique Arquivo >> Novo
  4. Salve o arquivo em sua pasta de trabalho. Você pode nomear o que quiser. Eu não estou me sentindo tão criativo, então vou nomear "postar".

Você vai acabar com isso:

Para pontos de bônus, no Typora, clique em Visão >> Esboço e você verá um bom resumo baseado em títulos de seu trabalho enquanto escreve. É uma visão estrutural do seu conteúdo. E estrutura é o que somos, certo?

Vista de estrutura de tópicos em Typora

Vista de estrutura de tópicos em Typora

Etapa 2: Crie seu repositório do Github

O Git é bem intimidante até você dividir em etapas:

  1. Abra o Github Desktop
  2. Clique Arquivo >> Adicionar Repositório Local
  3. Escolha sua pasta de trabalho
  4. Se o Github Desktop perguntar, clique em crie um repositório aqui
    Crie um novo repositório no Github Desktop

    Crie um novo repositório no Github Desktop

  5. Clique Criar Repositório ou Adicionar Repositório como relevante
  6. O Github faz a sua coisa. Se você procurar na sua pasta e puder ver arquivos ocultos, poderá ver algumas coisas como esta. Eles pertencem lá. Deixe-os continuar com suas vidas:
    Pasta de projeto com arquivos GIT adicionados

    Ignore estes

  7. Você também verá o repositório à esquerda, assim:
Repositório Git, adicionado ao Github Desktop

Repositório Git, adicionado ao Github Desktop

Ele não terá o bloqueio até que você envie o repositório para o Github.com.

Agora que você fez tudo isso, aqui vai uma dica: você também pode criar um repositório arrastando uma pasta para o Github Desktop. Mas se você fizer isso, eu nego toda a responsabilidade. Eu tive resultados muito estranhos com o recurso arrastar e soltar. O que é razoável a partir de uma ferramenta criada por pessoas que provavelmente não usaram um mouse em 20 anos. Eu digo isso com o maior respeito e admiração.

Etapa 3: Coloque seu repositório no Github.com

Até agora, você tem um repositório do Github no seu computador local. Isso não é tão útil. Agora você precisa "empurrar" tudo isso para o Github. Dessa forma, seus arquivos são copiados, você pode recuperá-los em qualquer lugar, e você pode ter outras pessoas trabalhando em sua escrita.

  1. Na área de trabalho do Github, clique no Publicar Repositório botão. Aqui está o que parece no OS X:
    Publique o repositório do Github Desktop

    Publique o repositório do Github Desktop

  2. Verifica Mantenha este código privado
  3. A menos que você tenha configurado uma organização do Github ou tenha uma conta empresarial (você saberá se fizer isso), não altere nenhuma outra configuração
  4. Clique Publicar Repositório
  5. Se você não estiver conectado ao Github, receberá um aviso de login.
  6. O desktop do Github envia arquivos para a nuvem e cria um repositório na sua conta do Github

Feito. Se você quiser sair, faça login no github.com. Você verá que seu novo repositório é confortável e confortável:

Seu projeto de conteúdo, no Github

Seu projeto de conteúdo, no Github

Grandes projetos

O Github chuta as nádegas se você estiver criando algo grande e complicado. Se você está trabalhando em um grande projeto, você vai querer fazer algumas outras coisas:

  1. Adicione um readme.md. é um arquivo especial que o Github mostrará como parte da "página inicial" do seu projeto. É um excelente lugar para fazer anotações para o restante da equipe
  2. Convide outras pessoas para o repositório. Compartilhar é cuidar (o tipo de coisa que escrevo em um domingo quando reescrevo este post cinco vezes)
  3. Aprenda como filiais trabalhos. Eu escrevi um pouquinho sobre isso abaixo. Algum dia eu vou escrever um post separado

O que você tem

Agora você deve ter:

  • Uma casa para o seu trabalho, tanto na sua área de trabalho quanto no Github.com
  • Seus primeiros arquivos

Entre isso e algumas pausas para o banheiro, você gastou cerca de dez minutos.

Agora você pode escrever!

Escrevendo

Você sabe o que fazer. Escreva coisas. Adicione imagens e o que mais você precisar. Alguns poupadores de tempo e sanidade:

Estrutura

Lembre-se da regra número um: a estrutura é mais importante que o formato.

Use o esboço à mão no lado esquerdo do Typora para obter uma visão estrutural imediata do seu conteúdo:

Visualização de estrutura de tópicos mostra onde estou na estrutura de conteúdo

Visualização de estrutura de tópicos mostra onde estou na estrutura de conteúdo

Se você estiver trabalhando em um grande projeto de vários arquivos, poderá alterar o contorno para uma árvore de arquivos. Então você pode ver todos os arquivos de texto e Markdown. Eu sou um fã de estrutura de tópicos eu mesmo.

Sintaxe

Este não é um guia para o Markdown. Você pode achar aquilo aqui.

Mas siga estas diretrizes:

Cabeçalhos

Cabeçalhos são o núcleo da boa estrutura. Navegadores da Web, mecanismos de pesquisa, processadores de texto, softwares de apresentação e a maioria das outras ferramentas de conteúdo convertem cabeçalhos em blocos de conteúdo e elementos de contorno. Você deve usá-los.

Quando você cria um cabeçalho, use esta sintaxe:

# Cabeçallho 1

## Título 2

### Título 3

E assim por diante. Isso cria manchetes reais e estruturais.

Em HTML, essa marcação se torna a marcação adequada para cada nível de título:

Cabeçallho 1

Cabeçalho 2

Cabeçalho 3

E assim por diante. No Word, ele se tornará um cabeçalho apropriado 1, 2, 3. No Powerpoint, os cabeçalhos apropriados se tornam o contorno dos slides e os títulos dos slides.

Psst: Typora também tem um prático combo de teclas para definir os cabeçalhos. No OS X, o CMD + 1 cria um cabeçalho de nível um. CMD + 2 cria um cabeçalho de segundo nível. E assim por diante. No Windows, use CTRL + 1, etc.

Listas

As listas são o elemento estrutural mais importante. Listas em HTML são uma dor na bunda. As listas em Markdown são fáceis:

* Item da lista 1
* Item da lista 2
* Item da lista 3

Torna-se:

  • Listar item 1
  • Listar item 2
  • Listar item 3

Para listas numeradas, substitua * por números.

Quando você exporta para HTML, o Typora converte a lista Markdown para corrigir a marcação HTML:

  • Listar item 1
  • Listar item 2
  • Listar item 3

Ele também gerará uma lista adequada no Microsoft Word, RTF, etc., aplicando todos os estilos que você criou para listas.

Tabelas

Este é um bom motivo para usar o Typora. No Markdown, as tabelas são assim:

| Coluna 1 | Coluna 2 | Coluna 3 |
| -------- | -------- | -------- |
| Linha 1 | | |
| Linha 2 | | |
| Linha 3 | | |

Eu dou uma olhada nisso e meu cérebro vomita em sua boca.

Typora tem uma ótima ferramenta WYSIWYG que permite criar e gerenciar tabelas da mesma maneira que você faria – ouso dizer – um processador de texto. Ei, o Microsoft Word é bom em algumas coisas.

Essas tabelas convertem diretamente para HTML, .doc, etc.

Imagens

Como os arquivos do Markdown são texto, você não incorpora imagens diretamente neles. Em vez disso, você usa algum código para apontar para a imagem:

Adicionando uma imagem no Markdown

Adicionando uma imagem no Markdown

Quando você converte seu trabalho para .doc, Google Docs ou PDF, o conversor incorpora as imagens. Mas se você estiver convertendo tudo isso em uma postagem do blog, por exemplo, no WordPress, será necessário inserir as imagens novamente.

Vadio.

Você ainda deve inserir as imagens. Dessa forma, você poderá vê-los e ter uma ideia de como eles aparecerão no documento final. E, quando você gerar formatos diferentes de HTML, as imagens aparecerão para o passeio. Sim, você precisará inseri-los novamente no WordPress. Mas é rápido, pois você já tem todas as imagens em uma pasta legal e organizada no seu laptop.

Novamente, o Typora facilita a inserção de imagens: clique em Formato >> Imagem e insere o código, bem como uma bela caixa de diálogo para que você possa selecionar a imagem.

Os links usam o mesmo código das imagens, mas remova o "!"

[Link text here](https://www.portent.com)

Torna-se

Link de texto aqui

Observe que o Typora visualiza automaticamente o link para você, ocultando o código e substituindo-o pelo texto do link.

TextExpander, citações inteligentes e entidades

Isto não é uma coisa de estrutura. É tudo sobre as regras dois e três: ferramentas proprietárias são armadilhas e redirecionamento é inevitável.

Existem citações idiotas:

" Uma citação burra

& apos; Uma simples citação idiota

E existem citações inteligentes:

Uma simples citação esquerda

' Uma simples citação simples à direita

Uma inteligente citação dupla à esquerda

" Uma citação inteligente

Há hífens e travessões, elipses e todos os outros tipos de símbolos inteligentes. Elas parecem muito melhores do que as cotações normais e são mais fáceis de usar do que as marcas registradas e os longos traços da codificação manual.

Para mostrar corretamente caracteres inteligentes Em HTML, você precisa usar entidades. Por exemplo, & lsquo; mostra uma aspa inteligente à esquerda. As entidades serão convertidas corretamente do Markdown para HTML, Word e todos os outros formatos.

Mas acabei de completar 50 anos. Não me lembro disso & lsquo; é a entidade para uma aspa simples inteligente esquerda. Não me lembro onde deixei meu capacete de bicicleta.

É aí que o TextExpander é útil. Se você pegou a coleção de trechos que eu fiz o link acima – aqui está de novo – então você tem um atalho.

Se você precisar de uma aspa simples inteligente, digite .ldq + TAB. TextExpander vai transformar esse atalho em & ldquo;. Ele fará o mesmo com as elipses (.ep) e um monte de outras. Você pode procurar a coleção de snippets para ver o que está disponível. Se você precisar de algo mais, me avise e eu adicionarei.

Você pode usar o TextExpander para outras coisas. Vá ler sobre isso. Isso economizará mais tempo para você escrever.

Eu escrevi um post sobre pequenas coisas para melhorar seu conteúdo. Citações inteligentes faziam parte disso. Dar uma olhada.

O que você tem

Você está criando conteúdo estruturado sem ferramentas ou formatos proprietários. Está pronto para publicação em vários formatos. Você pregou todas as regras do fluxo de trabalho de conteúdo.

Tempo economizado

Como você está escrevendo para a estrutura, pode digitar seus cérebros, criar cabeçalhos e outros, sem se preocupar com a aparência do seu conteúdo. Seu trabalho irá aplicar qualquer modelo ou CSS está esperando por ele quando você publicar.

Minha matemática: Trabalhar no Markdown me economiza cerca de 10 minutos para cada hora de trabalho em um projeto de redação.

Comprometendo seu trabalho (salvando, mais ou menos)

Lembre-se, todos os bons escritores são hoarders.

As crianças legais chamam isso de "comprometimento" e não "salvamento".

Configure qualquer ferramenta de edição que você use – Typora ou outra coisa – para salvar automaticamente, é claro. Mas isso apenas salva seu trabalho no arquivo original.

Ele não faz nenhum gerenciamento bacana da versão, e não o leva para o Github, onde o arquivo pode ficar tranquilo e seguro com todos os arquivos de imagem relacionados, arquivos de suporte etc. etc.

Sempre que você terminar uma seção, ou um rascunho, ou fizer uma pausa, use o Github Desktop para comprometer seu trabalho. A confirmação salva um instantâneo de todos os arquivos em seu projeto, incluindo o seu Markdown.

Acabei de terminar de escrever esta seção. Um dos meus gatos está exigindo uma massagem na barriga. Antes de eu dar aquela massagem na barriga e ela me deixar vivo (o que ela vai fazer), eu cometo meu trabalho:

  1. Abra o Github Desktop
  2. Certifique-se de que você selecionou seu projeto como o repositório atual:
    O repositório atual, selecionado no Github Desktop

    O repositório atual

  3. Se você está trabalhando e fazendo alterações há algum tempo, verá todos os tipos de coisas interessantes. Uma lista de arquivos alterados (1), notação mostrando o texto que você excluiu (2), texto que você adicionou e alterações mais antigas (3):
    Repositório Atual

    Repositório Atual

  4. Olhe no canto inferior esquerdo da janela do Github Desktop. Veja o campo que diz "Resumo (obrigatório)"
    Inserindo um resumo no Github

    Inserindo um resumo no Github

  5. Digite um rótulo para este instantâneo. Eu costumo usar uma frase curta que indica onde eu parei, como "Acabei de terminar o primeiro rascunho da seção de trabalho comprometido". Você também pode inserir uma descrição se quiser.

  6. Clique Comprometer-se a dominar. "Mestre" pode ser uma palavra diferente, dependendo do ramo (outro conceito para mais tarde). 99,999% do tempo, ele lerá Comprometer-se a dominar.
  7. O Github Desktop salva um instantâneo de todos os arquivos como existem agora, com o seu rótulo.

É isso aí. Eu vou acariciar meu gato, depois uso Neosporin depois que ela tenta arrancar meu braço, depois voltar ao trabalho. Da próxima vez que eu fizer uma pausa, vou fazer as alterações. E assim por diante.

Por que você faz isso? E preste atenção, porque isso é incrível. Agora posso ver todos os commits no Github Desktop, até as edições individuais que fiz. Eu posso subir e descer a História, indo até o começo da minha escrita.

Como o Github pode economizar tempo dos escritores

Eu escrevi uma metáfora engraçada sobre macacos, cortiça e pedras. Eu me desfaço. Mas não há lugar em uma peça escrita que já seja muito longa, então eu a excluo.

Eu Faz quero usá-lo em uma palestra que estou dando no Learn Inbound. Então, eu excluo toda a seção e, em seguida, confirmo a alteração:

Excluindo uma seção e, em seguida, confirmando a alteração para que eu não esqueça

Excluindo uma seção e, em seguida, confirmando a alteração para que eu não esqueça

Posso recuperá-lo mais tarde e, se alguém mais fizer uma revisão, eles poderão ver o que eu fiz e por quê.

Eu também posso recuperar arquivos que eu possa ter excluído.

Empurrando suas alterações para o Github

Você tem tudo comprometido em seu computador. Isso não será muito bom se:

  • Seu computador sai voando da sua mochila enquanto você está de bicicleta em casa (aconteceu)
  • Que UMA VEZ você decide não levar seu laptop de férias, de repente você se lembra que precisa adicionar uma seção à sua peça (aconteceu)
  • Você quer que alguém dê uma olhada, mas você não pode enviar uma cópia por e-mail para eles (aconteceu)
  • Você odeia o que você escreveu, decide começar tudo de novo, apagar tudo em um ajuste, então se arrepende (nunca aconteceu)

Você precisa "empurrar" suas alterações para o Github.com:

  1. Na área de trabalho do Github, clique em Empurre a origem:
Origem push

Origem push

Na verdade, é um processo de uma etapa. Você está feito.

Todas as alterações que você fez agora são enviadas ("enviadas") para o Github.

No mínimo, é o melhor backup de todos os tempos.

Mas é muito mais do que isso. Estas são algumas coisas que você pode fazer. Eu não vou entrar nos procedimentos para cada um. Saber que eles estão disponíveis é o suficiente por enquanto:

  • Forneça três cópias de seu trabalho para três pessoas, deixe-as editar de forma independente, depois compare e mescle as alterações
  • Recupere seu trabalho em qualquer lugar, trabalhe nele e, em seguida, verifique-o novamente
  • Recupere uma imagem que você excluiu há um mês
  • Publicar automaticamente quando você empurra para o Github (ooooohhhh ahhhhhh)
  • Empurre automaticamente para o Github quando você publicar (ooooh ahhhhhh)
  • Publique livros inteiros no Github

Arrumado.

Exibindo: fluxo de trabalho da equipe com o Github

Digamos que você queira entregar sua postagem do blog para o restante de sua equipe para revisão. O que você faz?

A maioria das pessoas copia e cola a postagem do blog no Word ou no Google Docs. Os outros escritores fazem suas edições usando o modo Rastrear Alterações ou Recomendações. Então você revisa e aceita / rejeita cada mudança e faça a alteração correspondente no seu HTML original, texto ou outro formato.

Eesh

Em vez disso, passe seu arquivo do Markdown para seus colegas de equipe. Deixe-os editá-lo. Em seguida, verifique suas alterações e aceite ou rejeite-as no original.

Fazer isso:

  1. Compartilhe seu projeto com seus colegas de equipe
  2. Crie um ramo para cada colega de equipe
  3. Deixe-os fazer o seu trabalho
  4. Comparar filiais com alterações sinalizadas
  5. Aceitar ou rejeitá-los, ramo a ramo
  6. Mesclar os ramos de volta para o "mestre" original

Sem recortar e colar de e para o Word ou o Google Docs.

É um pouco mais complicado que isso. Se você chegar a um ponto em que está usando fluxos de trabalho baseados em equipe, aproveite para aprender como funciona o branching. Por enquanto, coloque um marcador aqui. Entenda que isso é possível e que você tem as ferramentas para apoiá-lo.

O que você tem

Agora você tem um backup sólido e salva o conjunto de ferramentas. Você pode ser um colecionador ordenado, seguindo a Regra Quatro do Fluxo de Trabalho de Conteúdo. Você pode suportar fluxos de trabalho de equipe mais complexos posteriormente.

Tempo economizado

O Github Desktop me permite acumular todas as mudanças que já fiz em qualquer arquivo deste projeto.

Sim, fico um pouco animado pensando nisso.

Tempo economizado: Passei uma hora ou duas tentando rastrear uma nota ou uma alteração ou substituindo imagens, vídeos ou anexos perdidos. Isso garante que eu nunca precise fazer isso novamente.

Publicação

Depois de tudo isso, é hora de publicar.

Se você seguiu esse fluxo de trabalho, seu conteúdo é estruturalmente sólido: você pode soltá-lo em qualquer modelo no Word, no Google Docs, no InDesign ou no seu website ou blog. Sua escrita adotará o modelo ou CSS do documento ou site. Você pode publicar seu conteúdo em vários formatos de uma única fonte sem (ou pelo menos muito pouco) tempo gasto formatando.

Tempo economizado: Gobs e Gobs.

Exportando para HTML

Você pode exportar usando as ferramentas internas do Typora de três maneiras:

Se você está publicando no WordPress (ou em outro CMS)

Se você está publicando no WordPress ou em qualquer outro CMS que permita a entrada de HTML, você deseja recortar e colar HTML diretamente no editor do WordPress:

  1. Selecione a peça inteira. Você pode usar Selecionar tudo ou qualquer combinação de teclas seleciona todos
  2. Clique Editar >> Copiar como código HTML
  3. Cole o resultado no WordPress

Você acabou de colar em HTML limpo e agradável. Insira suas imagens e você está pronto para ir.

Você vai perguntar sobre o novo editor de Gutenberg. Está chegando ao WordPress. Não suporta Markdown tão bem assim. Mas vamos ver: ainda é no início do Beta.

Salvando HTML para publicação em qualquer lugar

Se você estiver publicando em qualquer lugar, poderá exportar HTML:

  1. Clique Arquivo >> Exportar >> HTML (sem estilos)
  2. Nomeie o arquivo
  3. Poof. Você tem HTML. Com imagens e todos os tipos de presentes:
HTML exportado do Markdown, usando o Typora

HTML exportado do Markdown, usando o Typora

A imagem é descompactada e não é configurada porque deixei assim. Eu sei que a redefinição é inevitável (terceiro fluxo de trabalho de regra de conteúdo). Por enquanto, estou deixando minhas imagens em paz.

O Typora gera HTML despojado: sem CSS, sem formatação de qualquer tipo.

Salvando HTML com Formatação

Você também pode salvar HTML com CSS. Clique Arquivo >> Exportar >> HTML.

Typora gera HTML usando qualquer tema que você usou.

"Temas" são diferentes modelos HTML que você pode aplicar à sua escrita no Typora. Clique Temas na barra de menu. Você verá diferentes opções. Experimente. Não vai quebrar nada.

Se você exportar HTML com estilos, o Typora usa o tema como seu modelo.

E sim, você pode criar temas personalizados. Isso é um outro post ou seis.

Criação Avançada de HTML

Se você quiser ficar agitado, instale o Marcado 2, abra seu arquivo Markdown e selecione Editar >> Copiar fonte HTML. Isso faz com que você tenha o HTML mais puro e pronto para publicação, com IDs de cabeçalho e entidades adequados. Até agora a única pessoa que já notou a diferença era eu, no entanto. A menos que você seja louco, o Typora funcionará bem.

Uma nota rápida sobre o Typora E “quebra de dados”

O Typora insere este estranho código em todos os H1s:

Eu sinceramente não tenho certeza do que é. Eu provavelmente deveria saber. Eu não. Eu não gosto de pontas soltas, então normalmente eu apago isso. Se alguém descobrir para que serve, me avise.

Exportando para outros formatos

O Typora suporta nativamente muitos formatos. Clique Arquivo >> Exportar e você pode ver uma lista. Formatos notáveis ​​incluem:

  • PDF: usa o tema que você selecionou. Isso raramente é ideal, por isso recomendo exportar para o Word. Apply whatever Word template you’re using, then save that as a PDF
  • Word: Uses whatever your computer’s default Word template is (normal.dot). You can then copy-and-paste into another template, or use Word’s style management tools
  • RTF (Rich Text Format): Great for pasting into Google Docs
  • Open Office: If you’re a rebel
  • Epub: Export straight to ebook format

Because your content is well-structured—headings are headings, bold is bold, lists are lists—you can apply whatever templates you’ve created.

Advanced Publishing With Pandoc

Pandoc is a super-advanced document converter. Here are a few things it can do:

  • Publish to multiple formats at once: For example, you can generate PDF, HTML, and Word with one command
  • Publish to Word using unique templates
  • Publish to HTML using specific templates
  • Publish lots of files to multiple formats

Here’s a quick example: I write lots of little documentation snippets for my team. These snippets are 5–10 sentences, with images. There are dozens, and I edit them all the time. I then provide them in Markdown, HTML, Word and Google Doc format. I use Pandoc to regenerate and export all four formats from a single set of files.

I also use Pandoc to publish to HTML and ebook format simultaneously.

Pandoc is complicated, though. It’s a command-line tool with a steep learning curve. Use with caution.

What You’ve Got

You’re now a publisher. From your single Markdown file, you can deliver HTML, Word, PDF and whatever else you need. You can do it without proprietary tools, and you can easily repurpose: Your publishing process follows Rules Of Content Workflow Two and Three.

Time Saved

Any time you move content from one format to another, you’ve got trouble:

  • Publishing to HTML from Word, you have to resize images and clean up formatting
  • Publishing to Word or PDF from HTML (it happens), you have to reformat and restructure your content to fit the target template

It’s a pain in the tuchus, and it wastes time. You save all of that by starting in Markdown and publishing to your various formats from there.

Reaproveitamento

Beating this to death:

If I decide six months from now to publish this post as an ebook, I can do it from Typora by clicking Arquivo >> Exportar >> Epub ou PDF. I won’t have to reformat anything.

If I want to republish on another website, I can do that, too, generating clean HTML that’s cut-and-paste ready.

I can generate a nice, neat outline in OPML.

I have pure, structural content I can move from format to format without breaking a sweat.

So What?

You just followed me down the nerdy rabbit hole, jumping from Markdown to Github and back again.

Why bother? Why not keep using Microsoft Word, and writing directly in WordPress?

Time.

No one gives us enough time to write. If they fez give us enough time, we’d want more of it.

Once you settle into this workflow, you’ll be more efficient. You can write more and spend more time polishing what you write. You’ll create better stuff.

This is a content workflow that poderia take us from the Age of the Word Processor—the age of boldface and comic sans—to the age of digital-ready structured content. And it makes us better writers at the same time.

What’s not to like?

Get In Touch (Really)

I’m a digital marketer. I don’t earn a living setting up content workflows. Contact me with questions, and you’ll only get advice. No pitch: @portentint and https://www.linkedin.com/in/ianlurie/

Recursos

Butterick’s Practical Typography
Little Things To Make Content Better
Markdown Syntax Guide
Typora

* “Fucklebucket” is a rated PG version of f–k. I came up with it once when, in front of my six and eight-year-old kids, I burned my finger on dry ice and started to drop an f-bomb. It was a pretty good save, I thought.

The post Content Workflow Using Github And Markdown appeared first on Portent.

Sites que valem a leitura:

De volta ao Básico: controle de Ângulos

5 opções de entrega de mercearia valem o preço porque tornam a vida mais fácil

Ganhe dinheiro vendendo fotos on-line

Como otimizar o conteúdo que será lido e compartilhado

Um negócio de marketing de afiliados é certo para mim?

Affiliatetheme.IO – tabela de produtos por tipo de resultado de teste

Mãos à obra! Tudo o que você precisa saber para criar um infoproduto em 7 dias sem morrer na tentativa

25 melhores ideias de novos negócios na Índia com investimento baixo e médio