markdown dungeon

⚔️ Markdown Dungeon ⚔️

Una mazmorra es un lugar o prisión donde se celebra a la gente. Por lo general, se pueden encontrar bajo tierra

Este es un ejemplo de la ilustración de repo de una mazmorra usando Markdown en GitHub. En la mazmorra, el lector elige qué opción tomar y salta a una página apropiada de la habitación que se basa en su elección. Es colaborativo porque la habitación está escrita por muchos autores.

Empiece un nuevo juego

? Instalación

Necesitas instalar hilo.

1. Clonar el repositorio

git clone https://github.com/MakeContributions/markdown-dungeon.git

2. Ir a la carpeta

 cd markdown-dungeon

3. Ejecutar la dependencia de instalación

yarn

4. Cree un archivo .env.development en la carpeta Root Project y copie el formato del archivo .env.example .
5. Para iniciar el servidor de desarrollo ejecutado:

yarn start

Asegúrese de no estar utilizando PowerShell

6. ? Abra su navegador y vaya a http: // localhost: 8000/o http: // localhost: 8000/___ Graphql

Formato de piso y habitación

Un piso es una carpeta y cada piso es una colección de habitaciones y cada habitación es un archivo Markdown . Los enlaces de capacidad de Markdown se usan para arriba/hacia abajo e ir a otra habitación, como el ejemplo a continuación.

Ir a la mazmorra de Github

 [ Go to Github dungeon ] ( https://github.com/ ) 

? ‍ Directrices de contribución

1.? Hacer cambios de tamaño adecuado

• Mantenga los cambios pequeños
• No agregue una opción sin agregar ninguna puerta para los lectores que decidan esa opción, para que la mazmorra no esté llena de enlaces muertos. En cambio, el último archivo de Markdown que el lector alcanza en cualquier ruta de la habitación no debe tener ninguna opción.

Aquí hay algunos ejemplos de cambios apropiados:

• Agregue una o dos oraciones a una "página" (archivo) existente en la sala.
• Agregue una nueva opción a un punto de elección existente y vincule esa opción a una "habitación" o "piso" existente.
• Agregue una nueva opción a un punto de elección existente, cree una nueva "página" para esa opción y agregue una oración o dos a la nueva "página".
• Agregue un par de opciones a una "página" actual "y agregue una" página "o enlace a una" página "existente para cada opción.

2. ⛩ Estructura de mazmorras

La estructura debe ser dungeon-name/floor-number/room-number , consulte las definiciones a continuación para cada variable:

• Nombre de mazmorra: es una carpeta que contiene número de piso, debe separar las palabras con un tablero (-), es alfanumérico. Ejemplo: Normal-Dungeon-1 .
• Número de piso: es una carpeta que contiene número de habitación, es numérico no agrega 0 antes del número.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• Número de habitación: es un archivo de Markdown, el nombre del archivo debe ser numérico, pero si tiene subconsiones de la habitación, podría separar el número de habitación con un tablero (-), la submarina podría ser alfanumérica.

 1, 2, 3-AF, 3-01 // Compliance

01A, 02*A3, A3+F // Non-Compliance

Carpeta o nombre de archivo solo acepta todos los caracteres ASCII y el tablero (-).

Si creó una nueva mazmorra, agregue Inicie un nuevo juego, agréguelo en la carpeta de imágenes y en la mazmorra-Info.json, para que el lector pueda ir a su mazmorra y abrirlo en el sitio web

Si desea obtener una idea de qué opción conduce a qué al contribuir, busque el archivo decision_tree.png en cualquier carpeta de mazmorras, que contiene una vista gráfica de esa mazmorra.

3.? Use enlaces relativos

Los enlaces en este archivo deben ser enlaces relativos para continuar funcionando si el repositorio está bifurcado.

4.? Longitudes de línea

Mantenga todas las líneas 120 caracteres o menos. De lo contrario, los archivos sin procesar serán difíciles de leer en el navegador o en la línea de comandos, y los cambios serán más difíciles de revisar.

5.? Líneas en blanco entre opciones

Inserte líneas en blanco entre las diferentes opciones para que las opciones estén separadas visualmente.

Licencia

MIT